CData Sync App は、Monday データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
Monday コネクタはCData Sync アプリケーションから使用可能で、Monday からデータを取得して、サポートされている任意の同期先に移動できます。
Sync App はMonday API を利用してMonday への双方向アクセスを実現します。
必須プロパティについては、設定タブを参照してください。
通常必須ではない接続プロパティについては、高度な設定タブを参照してください。
Monday AuditLog API は、API トークンによる認証のみをサポートしています。
監査ログAPI トークンを生成するには:
API トークンを取得した後、以下の接続プロパティを設定します。
Monday GraphQL API は、API トークンまたはOAuth 標準による認証をサポートしています。
API トークンでSync App に接続するには、AuthScheme をToken に設定し、次の手順でAPIToken を取得します。
以下のサブセクションでは、3つの一般的な認証フローでのMonday への認証について詳しく説明します。
カスタムOAuth アプリケーションの作成については、カスタムOAuth アプリケーションの作成 を参照してください。
Monday で利用可能な接続文字列プロパティの全リストは、Connection を参照してください。
アクセストークンの期限が切れたときは、Sync App は自動でアクセストークンをリフレッシュします。
OAuth アクセストークンの自動リフレッシュ:
Sync App がOAuth アクセストークンを自動的にリフレッシュするようにするには、次のように設定します。
このセクションでは、Monday Sync App の高度な機能を厳選して説明します。
Sync App はユーザー定義ビューの使用をサポートします。これは事前設定されたユーザー定義クエリによって内容が決定される仮想テーブルです。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。
SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。詳しくは、「接続文字列オプション」にあるSSLServerCert プロパティを参照してください。
Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。
詳しくは、クエリ処理 を参照してください。
デフォルトでは、Sync App はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。
別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。
HTTP プロキシへの認証には、以下のように設定します。
次のプロパティを設定します。
CData Sync App はMonday データをテーブル、ビュー、ストアドプロシージャを備えた使いやすいSQL データベースとしてモデル化します。
プロバイダーは3種類のスキーマを公開します。
In the Information Data Model schema, the provider models the data entities and relationships with the Monday.com platform as an easy-to-use SQL database. Live connectivity to these objects means that any changes to your Monday.com account are immediately reflected in the provider.
The テーブル section, which details standard SQL tables, and the ビュー section, which lists read-only SQL tables, contain samples of what you may have access to in your Monday account.
Common tables include:
| Table | Description |
| Boards | Retrieves a collection of boards, including their details and associated data. |
| BoardUsers | Retrieves a list of user subscribers for a specific board. |
| BoardTeams | Fetches a list of team subscribers associated with a specific board. |
| Columns | Retrieves the visible columns for a specific board, providing structural information. |
| Groups | Retrieves the visible groups for a specified board, providing a structured view of grouped items. |
| BoardViews | Retrieves a list of views configured for a specific board. |
| Users | Retrieves details about users within the Monday platform. |
| Updates | Fetches a collection of updates, including user comments, status changes, and other activity logs. |
| Tags | Retrieves a collection of tags used to categorize and filter items across boards. |
| Teams | Fetches metadata about teams in the Monday platform. |
| Workspaces | Retrieves a collection of workspaces, including their names and details. |
| Webhooks | Fetches a collection of webhooks, including their configuration and associated events. |
| Folders | Retrieves a collection of folders within workspaces. Excludes folders in closed workspaces unless you are subscribed to them. |
| Docs | Retrieves a collection of documents from workspaces, including their metadata. |
| DocBlocks | Fetches content blocks within documents associated with workspaces. |
| BoardDocs | Fetches a collection of documents associated with boards. Requires specifying an Id or ObjectId filter to identify the desired documents. |
| BoardDocBlocks | Retrieves content blocks from documents associated with boards. Requires a DocId or DocObjectId filter to narrow results. |
| WorkspaceUsers | Fetches the list of users subscribed to a specific workspace. |
| WorkspaceTeams | Retrieves the list of teams subscribed to a specific workspace. |
| CustomActivities | Retrieves metadata about custom activities in the Email and Activities timeline for enhanced activity tracking. |
ストアドプロシージャ are actions that are invoked via SQL queries. They perform tasks beyond standard CRUD operations, including duplicating items in a board, adding a file to a column value in a board, and sending a new notification to users.
Sync App はMonday のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
| Name | Description |
| Apps | Retrieve metadata about apps built with the apps framework. |
| BoardDocBlocks | Retrieves content blocks from documents associated with boards. Requires a DocId or DocObjectId filter to narrow results. |
| BoardDocs | Fetches a collection of documents associated with boards. Requires specifying an Id or ObjectId filter to identify the desired documents. |
| Boards | Retrieves a collection of boards, including their details and associated data. |
| BoardTeams | Fetches a list of team subscribers associated with a specific board. |
| BoardUsers | Retrieves a list of user subscribers for a specific board. |
| BoardViews | Fetches a list of views configured for a specific board. |
| Columns | Retrieves the visible columns for a specific board, providing structural information. |
| CustomActivities | Retrieves metadata about custom activities in the Email and Activities timeline for enhanced activity tracking. |
| DocBlocks | Fetches content blocks within documents associated with workspaces. |
| Docs | Retrieves a collection of documents from workspaces, including their metadata. |
| Favorites | Retrieve a user's favorites data via the API. |
| Folders | Retrieves a collection of folders within workspaces. Excludes folders in closed workspaces unless you are subscribed to them. |
| Groups | Retrieves the visible groups for a specified board, providing a structured view of grouped items. |
| ManagedColumns | Your accounts managed columns. |
| Objects | Get metadata for a collection of objects. |
| Tags | Retrieves a collection of tags used to categorize and filter items across boards. |
| Teams | Get a collection of teams. |
| TeamUsers | Get a team's users. |
| TimelineItems | Get metadata about items in the Email and Activities timeline. |
| Updates | Fetches a collection of updates, including user comments, status changes, and other activity logs. |
| Users | Retrieves a collection of users, including their details and roles. |
| Webhooks | Fetches a collection of webhooks, including their configuration and associated events. |
| WorkformQuestions | Get a collection of question for the specified formToken. |
| Workforms | Get a collection of forms. |
| WorkformTags | Get a collection of tags for the specified formToken. |
| Workspaces | Retrieves a collection of workspaces, including their names and details. |
| WorkspaceTeams | Retrieves the list of teams subscribed to a specific workspace. |
| WorkspaceUsers | Fetches the list of users subscribed to a specific workspace. |
Retrieve metadata about apps built with the apps framework.
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
For example, the following queries are processed server-side:
SELECT * FROM Apps WHERE Id = '10483971'
SELECT * FROM Apps WHERE Id IN ('10483971', '10483972')
The following columns can be used to create a new record:
Name, Kind, Description, Permissions, Slug, WebhookURL, CollaboratorIds
The following columns can be updated:
Name, Kind, Description, Permissions, Slug, WebhookURL, CollaboratorIds
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The app's unique identifier. | |
| AccountId | String | True |
The app's account ID | |
| ApiAppId | String | True |
The app's unique API consumer identifier. | |
| Name | String | False |
The app's name. | |
| Kind | String | False |
The app's kind. | |
| PhotoUrl | String | True |
the app photo url | |
| PhotoUrlSmall | String | True |
the app photo url for small size | |
| CreatedBy | String | True |
The unique identifier of the user who created the app. | |
| Description | String | False |
The app's description. | |
| Permissions | String | False |
The app's permissions. | |
| Slug | String | False |
The app's slug. | |
| Status | String | True |
The app's status. 使用できる値は次のとおりです。DRAFT, LIVE | |
| WebhookURL | String | False |
The app's webhook endpoint URL. | |
| CreatedAt | Datetime | True |
The app's creation date. | |
| UpdatedAt | Datetime | True |
The date the app was last updated. | |
| CollaboratorIds | String | False |
The app's collaborator ids. |
Retrieves content blocks from documents associated with boards. Requires a DocId or DocObjectId filter to narrow results.
Note: This table requires specifying DocId to retrieve data.
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.
For example, the following queries are processed server-side:
SELECT * FROM BoardDocBlocks WHERE DocId = '9014425'
SELECT * FROM BoardDocBlocks WHERE DocId IN ('9014425','9014490')
SELECT * FROM BoardDocBlocks WHERE DocId IN (SELECT ColumnDocId FROM Board)
The following columns can be used to create a new record:
ParentBlockId, DocId, Content, Type
The following pseudo-column can be used to create a new record:
AfterBlockId
INSERT INTO BoardDocBlocks (ParentBlockId,DocId,Type,Content,AfterBlockId) VALUES ('63bb329e-246d-57f5-7d43-2a13e893b431','9180448','code','{"alignment":"left","direction":"ltr","deltaFormat":[{"insert":"Test"}]}','53ab947f-226f-49f5-8d43-1021f9f36431')
The following column can be updated:
Content
UPDATE BoardDocBlocks SET Content='{"alignment":"left","direction":"ltr","deltaFormat":[{"insert":"NewValue"}]}' WHERE Id = '9b24043b-6ea9-46b0-9f0a-1ec226f12d21'
You can delete entries by specifying the following column:
Id
DELETE FROM BoardDocBlocks WHERE Id = '9b24043b-6ea9-46b0-9f0a-1ec226f12d21'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The unique identifier for the block, used to distinguish it from other blocks in the document. | |
| ParentBlockId | String | True |
The unique identifier of the parent block, establishing hierarchical relationships between blocks. | |
| DocId | String | True |
BoardDocs.Id |
The unique identifier of the document that contains this block. |
| CreatedById | String | True |
Users.Id |
The unique identifier of the user who created the block. |
| Position | Double | True |
The position of the block within the document, used to determine its order. | |
| Content | String | False |
The content of the block, which could include text, media, or other data. | |
| Type | String | True |
Specifies the type of content stored in the block, such as text, image, or table. 使用できる値は次のとおりです。board, bulleted_list, check_list, code, divider, image, large_title, layout, medium_title, normal_text, notice_box, numbered_list, quote, small_title, table, video, widget, page_break | |
| CreatedAt | Date | True |
The date when the block was initially created. | |
| UpdatedAt | Date | True |
The date when the block was last updated. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| AfterBlockId | String |
Specifies the unique identifier of the block after which this block should be inserted. If not provided, the block will be inserted at the beginning of the document. |
Fetches a collection of documents associated with boards. Requires specifying an Id or ObjectId filter to identify the desired documents.
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.
For example, the following queries are processed server-side:
SELECT * FROM BoardDocs WHERE Id = 'Val1'
SELECT * FROM BoardDocs WHERE ObjectId = 'Val1'
The following column can be used to create a new record:
The following pseudo-columns can be used to create a new record:
ItemId, ColumnId
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A unique identifier for the document within the system, ensuring each document is distinctly recognized. | |
| ObjectId | String | True |
The unique identifier of the object associated with this document, linking the document to its parent entity. | |
| WorkspaceId | String | True |
Workspaces.Id |
The unique identifier of the workspace where the document resides. A null value indicates it belongs to the main workspace. |
| CreatedById | String | True |
Users.Id |
The unique identifier of the user who created the document, allowing for tracking of document ownership. |
| DocKind | String | True |
Specifies the document's visibility or access type, such as public, private, or shared. 使用できる値は次のとおりです。public, private, share | |
| Name | String | True |
The name assigned to the document, used for identification and display purposes. | |
| RelativeUrl | String | True |
The relative URL of the document, specifying its location within the application's directory structure. | |
| Settings | String | True |
A JSON or serialized string containing configuration and settings specific to the document. | |
| Url | String | True |
The direct URL link to access the document, typically used for navigation. | |
| CreatedAt | Date | True |
The date and time when the document was created, stored in the system's standard date format. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| ItemId | String |
The unique identifier for the item associated with this document, linking it to its specific row or record. |
| ColumnId | String |
The unique identifier for the column associated with this document, representing its specific attribute or field. |
Retrieves a collection of boards, including their details and associated data.
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.
For example, the following queries are processed server-side:
SELECT * FROM Boards WHERE Id = '2181960030'
SELECT * FROM Boards WHERE Id IN ('2307103055', '2182296646', '2181960030')
SELECT * FROM Boards WHERE BoardKind = 'public'
SELECT * FROM Boards WHERE State = 'Val1'
SELECT * FROM Boards WHERE WorkspaceId = '1345997021'
The following columns can be used to create a new record: Name, Description, BoardKind, BoardFolderId, and WorkspaceId.
The following pseudo-columns can be used to create a new record: ItemNicknamePlural, ItemNicknamePresetType, ItemNicknameSingular, TemplateId, BoardOwnerIds, BoardOwnerTeamIds, BoardSubscriberIds, BoardSubscriberTeamIds, and Empty.
The following columns can be updated: Name, Description, Communication, and State.
The following pseudo-column can be used to update a record: BasicRoleName.
You can delete entries by specifying the following column: Id.
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A unique identifier for the board, used to distinguish it from other boards in the system. | |
| CreatorId | String | True |
Users.Id |
The unique identifier of the user who created the board. |
| Name | String | False |
The name of the board, representing its primary label or title. | |
| ItemTerminology | String | True |
Defines the terminology used for items on the board. Can be a predefined term or a custom value provided by the user. | |
| ItemsCount | Int | True |
The total number of items currently present on the board. | |
| TopGroupId | String | True |
Groups.Id |
The unique identifier of the top-level group associated with this board. |
| Description | String | False |
A detailed description or summary of the board's purpose or content. | |
| UpdatedAt | Datetime | True |
The timestamp indicating when the board was last updated. | |
| Type | String | True |
Specifies the type of board object, such as a task board or project board. | |
| Url | String | True |
The direct URL link to access the board. | |
| BoardKind | String | True |
Indicates the kind of board, such as public, private, or shared, determining its visibility and access. 使用できる値は次のとおりです。public, private, share | |
| BoardFolderId | String | True |
Folders.Id |
A unique identifier for the board's folder within the system. |
| Communication | String | False |
Specifies the communication identifier associated with the board, typically a meeting ID or collaboration reference. | |
| Permissions | String | True |
Defines the permissions or access controls assigned to the board. | |
| TagsIds | String | True |
Tags.Id |
A comma-separated list of unique identifiers for the tags associated with the board. |
| State | String | False |
Indicates the current state of the board, such as 'all', 'active', 'archived', or 'deleted'. | |
| WorkspaceId | String | True |
Workspaces.Id |
The unique identifier of the workspace containing the board. A null value indicates the board belongs to the main workspace. |
| AccessLevel | String | True |
The user's board permission level. | |
| ObjectTypeUniqueIdentifier | String | True |
A unique identifier for the board's object type. | |
| CreatedAt | Datetime | False |
The date and time when the board was created. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| ItemNicknamePlural | String |
The plural form of the item nickname. |
| ItemNicknamePresetType | String |
The preset type for item nickname. |
| ItemNicknameSingular | String |
The singular form of the item nickname. |
| TemplateId | String |
Specifies the unique identifier of an optional template used to create the board. |
| BoardOwnerIds | String |
An optional, comma-separated list of user IDs representing the owners of the board. |
| BoardOwnerTeamIds | String |
An optional, comma-separated list of team IDs representing the owner teams of the board. |
| BoardSubscriberIds | String |
An optional, comma-separated list of user IDs representing subscribers to the board. |
| BoardSubscriberTeamIds | String |
An optional, comma-separated list of team IDs representing subscriber teams to the board. |
| Empty | Bool |
An optional flag indicating whether to create an empty board without any default items. |
| BasicRoleName | String |
The role's name. |
Fetches a list of team subscribers associated with a specific board.
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.
SELECT * FROM BoardTeams WHERE BoardId='5557271485'
SELECT * FROM BoardTeams WHERE Kind = 'owner'
Note: API limitations may cause affected row counts or generated keys to be reported inaccurately when attempting to create relationships between entities that are already related.
The following inputs can be used in INSERT statements:
Id, BoardId, Kind
INSERT INTO BoardTeams (Id,BoardId,Kind) VALUES ('51688059','5546871560','subscriber')
Note: API limitations may cause affected row counts to be reported inaccurately when attempting to delete relationships between entities that are not related.
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 | True |
Teams.Id |
A unique identifier for each board team entry, ensuring distinct records in the table. |
| BoardId [KEY] | String | True |
Boards.Id |
Represents the unique identifier of the board associated with the team, linking the team to its respective board. |
| Kind | String | True |
Specifies the role of the team within the board, such as 'subscriber' or 'owner'. Note that all owners are implicitly subscribers. Use this column to differentiate between owners and non-owner subscribers. 使用できる値は次のとおりです。owner, subscriber |
Retrieves a list of user subscribers for a specific board.
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.
For example, the following queries are processed server-side:
SELECT * FROM BoardUsers WHERE BoardId = 'Val1'
SELECT * FROM BoardUsers WHERE Kind = 'owner'
The following columns can be used to create a new record:
Id, BoardId, Kind
You can delete entries by specifying the following columns:
Id, BoardId
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Users.Id |
The unique identifier for the board owner, used to distinguish users associated with different boards. |
| BoardId [KEY] | String | True |
Boards.Id |
The unique identifier of the board to which the user is linked. This is used to associate users with specific boards. |
| Kind | String | True |
Indicates the role of the user on the board. Valid roles are 'subscriber' or 'owner'. Owners are implicitly subscribers but can be differentiated using this column to filter non-owners. 使用できる値は次のとおりです。owner, subscriber |
Fetches a list of views configured for a specific board.
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.
For example, the following queries are processed server-side:
SELECT * FROM BoardViews WHERE Id = 'Val1'
SELECT * FROM BoardViews WHERE BoardId = 'Val1'
SELECT * FROM BoardViews WHERE Type = 'Val1'
The following columns can be used to create a new record:
BoardId, Name, Settings, Type, FilterTeamId, FilterUserId, Sort, Tags
The following pseudo-columns can be used to create a new record:
FilterGroups (references ViewQueryGroup), FilterOperator, FilterRules (references ViewQueryRule)
| Column Name | Type | Description |
| Groups (references ViewQueryGroup) | 115tring | The rule groups to filter your queries. |
| Operator | 115tring | The operator to use for the rule groups. |
| Rules (references ViewQueryRule) | 115tring | The rules to filter your queries. |
| Column Name | Type | Description |
| ColumnId | 115tring | The unique identifier of the column to filter by. |
| CompareAttribute | 115tring | The comparison attribute. |
| CompareValue | 115tring | The column value to filter by. |
| Operator | 115tring | The condition for value comparison. |
The following columns can be updated:
Name, Settings, Type, FilterTeamId, FilterUserId, Sort, Tags
The following pseudo-columns can be used to update a record:
FilterGroups (references ViewQueryGroup), FilterOperator, FilterRules (references ViewQueryRule)
| Column Name | Type | Description |
| Groups (references ViewQueryGroup) | 115tring | The rule groups to filter your queries. |
| Operator | 115tring | The operator to use for the rule groups. |
| Rules (references ViewQueryRule) | 115tring | The rules to filter your queries. |
| Column Name | Type | Description |
| ColumnId | 115tring | The unique identifier of the column to filter by. |
| CompareAttribute | 115tring | The comparison attribute. |
| CompareValue | 115tring | The column value to filter by. |
| Operator | 115tring | The condition for value comparison. |
You can delete entries by specifying the following columns:
Id, BoardId
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A unique identifier for the board view. Used to distinguish this view from others. | |
| BoardId [KEY] | String | True |
Boards.Id |
The unique identifier of the board to which this view belongs. Links the view to its parent board. |
| Name | String | False |
The name of the board view, typically used for identification and display purposes. | |
| Settings | String | False |
The settings for the board view, stored as a string. Includes configurations specific to this view. | |
| Type | String | False |
The type of the board view, indicating its category or functionality (for example, Kanban, Calendar). | |
| ViewSpecificData | String | True |
Additional data specific to this board view. Supported only for form-based views and stored in a string format. | |
| SourceViewId | String | True |
The unique identifier of the template view if this view was created as a duplicate of another view. | |
| AccessLevel | String | True |
The user's board view access level. 使用できる値は次のとおりです。edit, view | |
| Filter | String | True |
The view's filter metadata. | |
| FilterTeamId | String | False |
The team ID the view is filtered by. | |
| FilterUserId | String | False |
The user ID the view is filtered by. | |
| Sort | String | False |
The view's sort metadata. | |
| Tags | String | False |
The view's tags. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| FilterGroups | String |
The rule groups to filter your queries. |
| FilterOperator | String |
The operator to use for the rule groups. 使用できる値は次のとおりです。and, or |
| FilterRules | String |
The rules to filter your queries. |
Retrieves the visible columns for a specific board, providing structural information.
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.
For example, the following queries are processed server-side:
SELECT * FROM Columns WHERE Id = 'name'
SELECT * FROM Columns WHERE Id IN ('name', 'status')
SELECT * FROM Columns WHERE BoardId = '128443935'
SELECT * FROM Columns WHERE Type = 'board-relation'
The following columns can be used to create a new record:
Id, BoardId, Settings, Title, Description, Type, CapabilitiesFunction
The following pseudo-columns can be used to create a new record:
AfterColumnId, SettingsLabels (references ColumnSettings), SettingsDropdownLimitCount, SettingsDropdownLimitSelect
| Column Name | Type | Description |
| Index | 105nt | The updated index of the new managed status column's label. |
| Color | 115tring | The updated color of the managed status column's label. |
| Description | 115tring | The status label's description. |
| IsDone | 98ool | Whether the label is marked as 'Done' |
| Label | 115tring | The updated text on the new managed status column's label. |
The following columns can be updated:
Settings, Title, Description, Type, Revision, CapabilitiesFunction
The following pseudo-columns can be used to update a record:
SettingsLabels (references ColumnSettings), SettingsDropdownLimitCount, SettingsDropdownLimitSelect
| Column Name | Type | Description |
| Id | 105nt | The unique identifier of the existing label to update. |
| Index | 105nt | The updated index of the new managed status column's label. |
| Color | 115tring | The updated color of the managed status column's label. |
| Description | 115tring | The status label's description. |
| IsDone | 98ool | Whether the label is marked as 'Done' |
| IsDeactivated | 98ool | Whether the status label is deactivated. |
| Label | 115tring | The updated text on the new managed status column's label. |
You can delete entries by specifying the following columns:
Id, BoardId
DELETE FROM Boards WHERE Id='test' AND BoardId='3820334'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The unique identifier for the column within its associated board. Ensures each column can be referenced individually. | |
| BoardId [KEY] | String | True |
Boards.Id |
The unique identifier of the board to which the column belongs. Used to establish a relationship between the column and its parent board. |
| Archived | Bool | True |
Indicates whether the column is archived. A value of 'true' means the column is no longer actively used but remains stored for reference. | |
| Settings | String | False |
Contains the column's settings stored in a serialized string format. These settings define the column's configuration and behavior. | |
| Title | String | False |
The display name or title of the column, used to identify its purpose or content visually. | |
| Description | String | False |
A detailed description of the column's purpose or content. Provides additional context for users. | |
| Type | String | False |
Specifies the type of the column, indicating its role or the kind of data it contains (for example, 'text', 'number', 'date'). | |
| Width | Int | True |
Defines the width of the column in terms of pixels or a similar unit. Determines how much screen space the column occupies. | |
| Revision | String | False |
The column’s current revision. | |
| CapabilitiesCalculatedType | String | True |
The type of calculated value. | |
| CapabilitiesFunction | String | False |
The function to calculate the parent values. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| AfterColumnId | String |
The unique identifier of the column after which the current column will be inserted. Used to specify the placement of a new column relative to existing ones. |
| SettingsLabels | String |
An array containing the dropdown column's labels |
| SettingsDropdownLimitCount | Int |
The maximum number of labels that can be selected. |
| SettingsDropdownLimitSelect | Bool |
Whether to limit the number of labels that can be selected. |
Retrieves metadata about custom activities in the Email and Activities timeline for enhanced activity tracking.
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.
For example, the following queries are processed server-side:
SELECT * FROM CustomActivities WHERE Id ='a91e9318-798a-44a6-80a4-49a14e23c015'
SELECT * FROM CustomActivities WHERE Name = 'TestName'
SELECT * FROM CustomActivities WHERE IconId = 'ASCENDING'
SELECT * FROM CustomActivities WHERE Color = 'BRINK_PINK'
The following columns can be used to create a new record:
Name, IconId, Color
INSERT INTO CustomActivities (Name, IconId, Color) values ('CActivity', 'CAMERA', 'MEDIUM_TURQUOISE')
You can delete entries by specifying the following column:
Id
DELETE FROM CustomActivities WHERE Id='a91e9318-798a-44a6-80a4-49a14e23c015'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The unique identifier for the custom activity, used to reference and distinguish it from other activities in the system. | |
| Type | String | True |
The classification of the custom activity, indicating its role or category within the broader activity framework (for example, 'Workflow', 'Task'). | |
| Name | String | True |
The human-readable name of the custom activity, displayed in user interfaces or reports to identify it. | |
| IconId | String | True |
An identifier corresponding to the icon representing the custom activity, used to visually distinguish it in the user interface. 使用できる値は次のとおりです。ASCENDING, CAMERA, CONFERENCE, FLAG, GIFT, HEADPHONES, HOMEKEYS, LOCATION, NOTEBOOK, PAPERPLANE, PLANE, PLIERS, TRIPOD, TWOFLAGS, UTENCILS | |
| Color | String | True |
The color associated with the custom activity, typically used for visual categorization or to provide a thematic representation in the UI. 使用できる値は次のとおりです。BRINK_PINK, CELTIC_BLUE, CORNFLOWER_BLUE, DINGY_DUNGEON, GO_GREEN, GRAY, LIGHT_DEEP_PINK, LIGHT_HOT_PINK, MAYA_BLUE, MEDIUM_TURQUOISE, PARADISE_PINK, PHILIPPINE_GREEN, PHILIPPINE_YELLOW, SLATE_BLUE, VIVID_CERULEAN, YANKEES_BLUE, YELLOW_GREEN, YELLOW_ORANGE |
Fetches content blocks within documents associated with 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.
For example, the following queries are processed server-side:
SELECT * FROM DocBlocks WHERE DocId = '9014425'
SELECT * FROM DocBlocks WHERE DocId IN ('9014425','9014490')'
The following columns can be used to create a new record:
ParentBlockId, DocId, Content, Type
The following pseudo-column can be used to create a new record:
AfterBlockId
INSERT INTO DocBlocks (DocId,Type,Content,AfterBlockId) VALUES ('9180448','code','{"alignment":"left","direction":"ltr","deltaFormat":[{"insert":"Test"}]}','53ab947f-226f-49f5-8d43-1021f9f36431')
The following column can be updated:
Content
UPDATE DocBlocks SET Content = '{"alignment":"left","direction":"ltr","deltaFormat":[{"insert":"NewValue"}]}' WHERE Id = '9b24043b-6ea9-46b0-9f0a-1ec226f12d21'
You can delete entries by specifying the following column:
Id
DELETE FROM DocBlocks WHERE Id = '9b24043b-6ea9-46b0-9f0a-1ec226f12d21'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The unique identifier for the block within the document, ensuring each block can be individually referenced and tracked. | |
| ParentBlockId | String | True |
The unique identifier of the block's parent, establishing the hierarchical relationship between blocks in the document structure. | |
| DocId | String | True |
Docs.Id |
The unique identifier for the document to which the block belongs, helping link blocks to specific documents in the system. |
| CreatedById | String | True |
Users.Id |
The unique identifier of the user who created the block, allowing traceability of the block's origin and providing context for audit trails. |
| Position | Double | True |
The position of the block within the document, typically represented as a floating-point number to precisely determine its order or location relative to other blocks. | |
| Content | String | False |
The actual content of the block, which may include text, media, or other data, depending on the block type and intended usage. | |
| Type | String | True |
The type of content within the block, indicating whether it contains text, an image, or another format, helping to differentiate the block's role in the document. 使用できる値は次のとおりです。board, bulleted_list, check_list, code, divider, image, large_title, layout, medium_title, normal_text, notice_box, numbered_list, quote, small_title, table, video, widget, page_break | |
| CreatedAt | Date | True |
The date and time when the block was created, providing a timestamp for when it was initially added to the document. | |
| UpdatedAt | Date | True |
The date and time when the block was last modified, tracking when changes were made to the block's content or attributes. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| AfterBlockId | String |
The identifier of the block that should appear immediately before the current block, allowing precise control over the order of blocks within a document. If not provided, the block will be inserted first in the document. |
Retrieves a collection of documents from workspaces, including their metadata.
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.
For example, the following queries are processed server-side:
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'
The following columns can be used to create a new record:
WorkspaceId, DocKind, Name
INSERT INTO Docs (WorkspaceId,DocKind,Name) VALUES ('3820334','public','CreatedDoc')
The following column can be updated:
Name
You can delete entries by specifying the following column:
Id
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A unique identifier assigned to the document, used to reference and distinguish the document in the system. | |
| DocFolderId | String | True |
Folders.Id |
The identifier of the folder where the document is stored. If the document is at the first level (root), this value is null. |
| ObjectId | String | True |
The unique identifier of the object associated with the document, allowing linkage between the document and the corresponding object in the system. | |
| WorkspaceId | String | True |
Workspaces.Id |
The identifier for the workspace where the document is located. If the document is in the main workspace, this value is null. |
| CreatedById | String | True |
Users.Id |
The unique identifier of the user who created the document, linking it to the creator's profile for tracking purposes. |
| DocKind | String | True |
Specifies the document's classification: public (accessible to all), private (restricted access), or shared (accessible to specific users). 使用できる値は次のとおりです。public, private, share | |
| Name | String | False |
The name or title of the document, typically used to identify it within the system or user interface. | |
| RelativeUrl | String | True |
The relative URL path of the document, which can be used to access it within the web application's context. | |
| Settings | String | True |
Stores configuration settings or preferences associated with the document, such as display or security settings. | |
| Url | String | True |
The direct, fully qualified URL that provides access to the document, usable for linking or direct access via a browser. | |
| CreatedAt | Date | True |
The timestamp representing when the document was created, useful for auditing and sorting documents chronologically. |
Retrieve a user's favorites data via the API.
The Sync App processes all filters client-side within the Sync App. The following query is the only one processed server-side:
SELECT * FROM Favorites
The following columns can be used to create a new record:
ObjectId, ObjectType
The following pseudo-columns can be used to create a new record:
Name, NextObjectId, NextObjectType, PrevObjectId, PrevObjectType
The following column can be updated:
FolderId
The following pseudo-columns can be used to update a record:
NextObjectId, NextObjectType, PrevObjectId, PrevObjectType
You can delete entries by specifying the following columns:
ObjectId, ObjectType
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The favorite object's unique identifier. | |
| AccountId | String | True |
The ID of the account the favorite object belongs to. | |
| FolderId | String | False |
The unique identifier of the folder the favorite object is in (if applicable). | |
| HierarchyListDataId | String | True |
The list's unique identifier. | |
| HierarchyListDataType | String | True |
The list's type. | |
| ObjectId [KEY] | String | True |
The object's unique identifier. | |
| ObjectType [KEY] | String | True |
The object's type. | |
| Position | Double | True |
The favorite object's position within its list or folder. | |
| CreatedAt | Datetime | True |
The timestamp when the favorite object was created. | |
| UpdatedAt | Datetime | True |
The timestamp when the favorite object was last updated. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| Name | String |
The name of the object to mark as a favorite. |
| NextObjectId | String |
The next object's unique identifier. |
| NextObjectType | String |
The next object's type. |
| PrevObjectId | String |
The previous object's unique identifier. |
| PrevObjectType | String |
The previous object's type. |
Retrieves a collection of folders within workspaces. Excludes folders in closed workspaces unless you are subscribed to them.
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.
For example, the following queries are processed server-side:
SELECT * FROM Folders WHERE Id = '12622355'
SELECT * FROM Folders WHERE WorkspaceId = '3578971'
The following columns can be used to create a new record:
ParentId, WorkspaceId, Color, Name
INSERT INTO Folders (WorkspaceId,Name,Color) VALUES ('3578971','TestFolder','BRIGHT_BLUE')
The following columns can be updated:
ParentId, WorkspaceId, Color, Name
The following pseudo-columns can be used to update a record:
AccountProductId, PositionIsAfter, PositionObjectId, PositionObjectType
You can delete entries by specifying the following column:
Id
DELETE FROM Folders WHERE Id='12678064'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A unique identifier for the folder, used to reference the folder in the system or database. | |
| OwnerId | String | True |
Users.Id |
The unique identifier of the user who owns the folder, linking it to the user profile responsible for the folder. |
| ParentId | String | False |
The unique identifier of the folder's parent, allowing for hierarchical folder structures. This helps in organizing folders within a larger directory structure. | |
| SubFolderIds | String | True |
A list of unique identifiers for the subfolders contained within the current folder, enabling a nested folder structure. | |
| WorkspaceId | String | False |
Workspaces.Id |
The unique identifier of the workspace that the folder belongs to, helping to associate the folder with a specific project or team environment. |
| Color | String | False |
The color assigned to the folder for visual identification or categorization, often used to visually differentiate between folders in the user interface. 使用できる値は次のとおりです。DONE_GREEN, BRIGHT_GREEN, WORKING_ORANGE, DARK_ORANGE, SUNSET, STUCK_RED, DARK_RED, SOFIA_PINK, LIPSTICK, PURPLE, DARK_PURPLE, INDIGO, BRIGHT_BLUE, AQUAMARINE, CHILI_BLUE, NULL | |
| Name | String | False |
The name given to the folder, typically representing its content or purpose, and displayed in the system for easy identification. | |
| CreatedAt | Datetime | True |
The timestamp of when the folder was created, which helps track the folder's age and historical changes. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| AccountProductId | String |
The unique identifier of the product to move the folder to. |
| PositionIsAfter | Bool |
Specifies where to position the target folder relative to the reference object. |
| PositionObjectId | String |
The unique identifier of the reference object that the target folder should be positioned relative to. |
| PositionObjectType | String |
The type of the reference object. |
Retrieves the visible groups for a specified board, providing a structured view of grouped items.
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.
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'
The following columns can be used to create a new record:
BoardId, Color, Title
The following pseudo-columns can be used to create a new record:
RelativeTo, PositionRelativeMethod
INSERT INTO Groups (BoardId,Title,Color,RelativeTo,PositionRelativeMethod) VALUES ('5525287714','NewGroup','#9CD326','testgroup','after_at')
The following columns can be updated:
Archived, Color, Title
The following pseudo-columns can be used to update a record:
RelativePositionAfter, RelativePositionBefore
UPDATE Groups SET Color = '#9CD326' WHERE BoardId = '5525287714' AND Id = 'newgroup'
UPDATE Groups SET Archived = 'true' WHERE BoardId='5525287714' AND Id = 'newgroup'
You can delete entries by specifying the following columns:
Id, BoardId
DELETE FROM Groups WHERE BoardId = '5525287714' AND Id = 'testgroup'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The unique identifier assigned to the group within the system, ensuring that each group can be referenced distinctly. | |
| BoardId [KEY] | String | True |
Boards.Id |
The unique identifier of the board to which the group belongs, linking the group to a specific board in the database. |
| BoardURL | String | True |
The URL of the board associated with the group, providing a direct link for accessing the board in the web interface. | |
| Archived | Bool | False |
A flag indicating whether the group is archived. A value of true means the group is archived and no longer actively used. | |
| Color | String | False |
The color associated with the group, typically used for visual identification or categorization within the board. 使用できる値は次のとおりです。#037f4c, #fdab3d, #579bfc, #e2445c, #00c875, #c4c4c4, #0086c0, #a25ddc, #ffcb00, #9cd326, #7f5347, #bb3354, #808080, #784bd1, #ff642e, #ff158a, #66ccff, #ff5ac4, #cab641 | |
| Deleted | Bool | True |
A flag that indicates whether the group has been deleted. A value of true means the group has been removed from the system. | |
| Position | String | True |
A string representing the position of the group on the board, often used for ordering groups in a list or layout. | |
| Title | String | False |
The title or name of the group, which provides a human-readable identifier for the group within the board. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| RelativeTo | String |
Specifies the group relative to which the current group's position should be set. This helps in defining the ordering between groups. |
| PositionRelativeMethod | String |
Describes the method used to determine the group's position relative to another group. Possible values include 'before_at' and 'after_at'. 使用できる値は次のとおりです。before_at, after_at |
| RelativePositionAfter | String |
Defines the position of the group relative to another group, specifically indicating that it should appear after the referenced group on the board. |
| RelativePositionBefore | String |
Defines the position of the group relative to another group, specifying that it should appear before the referenced group on the board. |
Your accounts managed columns.
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.
For example, the following queries are processed server-side:
SELECT * FROM ManagedColumns WHERE Id = '124423723'
SELECT * FROM ManagedColumns WHERE State = 'active'
The following columns can be used to create a new record:
Title, Description
The following pseudo-column can be used to create a new record:
Settings (references ColumnSettings)
| Column Name | Type | Description |
| Index | 105nt | The updated index of the new managed status column's label. |
| Color | 115tring | The updated color of the managed status column's label. |
| Description | 115tring | The status label's description. |
| IsDone | 98ool | Whether the label is marked as 'Done' |
| Label | 115tring | The updated text on the new managed status column's label. |
The following columns can be updated:
Title, Description, State, Revision
The following pseudo-column can be used to update a record:
Settings (references ColumnSettings)
| Column Name | Type | Description |
| Id | 105nt | The unique identifier of the existing label to update. |
| Index | 105nt | The updated index of the new managed status column's label. |
| Color | 115tring | The updated color of the managed status column's label. |
| Description | 115tring | The status label's description. |
| IsDone | 98ool | Whether the label is marked as 'Done' |
| IsDeactivated | 98ool | Whether the status label is deactivated. |
| Label | 115tring | The updated text on the new managed status column's label. |
You can delete entries by specifying the following column:
Id
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The unique identifier of the managed column. | |
| Title | String | False |
The managed column's title. | |
| Description | String | False |
The column's description. | |
| State | String | False |
The managed column's state. 使用できる値は次のとおりです。active, inactive, deleted | |
| SettingsJSON | String | True |
The managed column's settings in JSON. | |
| Revision | Int | False |
The current version of the managed column. | |
| CreatedAt | Datetime | True |
The managed column's creation date. | |
| CreatedBy | String | True |
The unique identifier of the user who created the managed column. | |
| UpdatedAt | Datetime | True |
The managed column's last updated date. | |
| UpdatedBy | String | True |
The unique identifier of the user who last updated the managed column. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| Type | String |
The managed column's type. |
| Settings | String |
The managed column's settings. |
Get metadata for a collection of objects.
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.
For example, the following queries are processed server-side:
SELECT * FROM Objects WHERE Id = '121246772'
SELECT * FROM Objects WHERE PrivacyKind = 'PRIVATE'
SELECT * FROM Objects WHERE State = 'ACTIVE'
SELECT * FROM Objects WHERE WorkspaceId = '12885370'
The following columns can be used to create a new record:
Description, FolderId, Name, OwnerIds, PrivacyKind, SubscriberIds, WorkspaceId
The following pseudo-columns can be used to create a new record:
ObjectTypeUniqueKey, OwnerTeamIds, SubscriberTeamIds, Payload
The following columns can be updated:
Description, Name, OwnerIds, PrivacyKind, State, SubscriberIds
The following pseudo-column can be used to update a record:
Kind
You can delete entries by specifying the following column:
Id
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The object's unique identifier. | |
| Creator | String | True |
The object's creator. | |
| Description | String | False |
The object's description. | |
| FolderId | String | True |
The unique identifier of the folder that contains the object. | |
| Name | String | False |
The object's name. | |
| OwnerIds | String | False |
The object's owner ids. | |
| PrivacyKind | String | False |
The object's visibility settings. 使用できる値は次のとおりです。PRIVATE, PUBLIC | |
| State | String | False |
The object's state. 使用できる値は次のとおりです。ACTIVE, ARCHIVED, DELETED | |
| SubscriberIds | String | False |
The object's subscriber ids. | |
| UpdatedAt | Datetime | True |
The object's last updated date. | |
| WorkspaceId | String | True |
The unique identifier of the workspace that contains the object. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| CreatedAt | String |
The order in which to return objects, in this case by created date. |
| UsedAt | String |
The order in which to return objects, in this case by used date. |
| ObjectTypeUniqueKey | String |
The object type's unique identifier. |
| OwnerTeamIds | String |
The unique identifiers of the new object's team owners. |
| SubscriberTeamIds | String |
The unique identifiers of the new object's team subscribers. |
| Payload | String |
The new object's JSON payload. |
| Kind | String |
The role to assign the subscribers. 使用できる値は次のとおりです。OWNER, SUBSCRIBER |
Retrieves a collection of tags used to categorize and filter items across 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.
For example, the following queries are processed server-side:
SELECT * FROM Tags WHERE IsPrivate = true
SELECT * FROM Tags WHERE Id = '13327214'
SELECT * FROM Tags WHERE Id IN ('13327214', '13327217')
The following columns can be used to create a new record:
Name, BoardId
INSERT INTO Tags (Name) VALUES ('TestTagName')
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The unique identifier for the tag, used to reference and distinguish it across the system. | |
| Color | String | True |
The color associated with the tag, which may be used to visually categorize or highlight the tag in the user interface. | |
| Name | String | True |
The name of the tag, typically used to describe or categorize items, and displayed in the user interface. | |
| IsPrivate | Bool | True |
Indicates whether the tag is private (visible only to specific users or groups) or public (accessible to everyone in the system). | |
| BoardId | String | True |
The identifier for a private board where the tag is created or filtered, relevant only for private boards, and not required for public boards. |
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.
For example, the following queries are processed server-side:
SELECT * FROM Teams WHERE Id = '565332'
SELECT * FROM Teams WHERE Id IN ('565332, 565333')
The following columns can be used to create a new record:
Name, IsGuestTeam
The following pseudo-columns can be used to create a new record:
ParentTeamId, TeamSubscriberIds, AllowEmptyTeam
You can delete entries by specifying the following column:
Id
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The unique identifier for the team, used to reference the team across the system. This ID ensures that each team can be distinguished and managed independently. | |
| Name | String | True |
The name of the team, which can be used to identify the team in user interfaces, reports, or other parts of the system. | |
| PictureUrl | String | True |
The URL link to the team's picture or logo, used for displaying visual representations of the team in the application or on web pages. | |
| IsGuestTeam | Bool | True |
Whether the team is a guest team. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| ParentTeamId | String |
Optional, the id of the parent team. |
| TeamSubscriberIds | String |
Optional, comma-separated list of team subscriber ids. |
| AllowEmptyTeam | Bool |
Optional flag to create an empty team (without any subscribers). |
Get a team's 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.
For example, the following queries are processed server-side:
SELECT * FROM TeamUsers WHERE TeamId = 'Val1'
SELECT * FROM TeamUsers WHERE Kind = 'member'
Note: API limitations may cause affected row counts or generated keys to be reported inaccurately when attempting to create relationships between entities that are already related.
The following columns can be used to create a new record:
Id, TeamId
INSERT INTO TeamUsers (Id, TeamId) VALUES ('57410919', '1127299')
The following column can be updated:
Kind
Note: API limitations may cause affected row counts to be reported inaccurately when attempting to delete relationships between entities that are not related.
You can delete entries by specifying the following columns:
Id, TeamId
DELETE FROM TeamUsers WHERE Id = '51688059' AND TeamId = '3820334'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Users.Id |
A unique identifier for the user within the system, used to differentiate and reference individual users across various processes and tables. |
| TeamId [KEY] | String | True |
Teams.Id |
A unique identifier for the team to which the user is assigned, enabling team-based filtering and operations within the platform. |
| Kind | String | False |
The user's role. All owners are by default also members. This column can be used to filter non-owners. 使用できる値は次のとおりです。member, owner |
Get metadata about items in the Email and Activities timeline.
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.
For example, the following queries are processed server-side:
SELECT * FROM TimelineItems WHERE Id ='2b748808-9311-4f76-80de-49baac5609e1'
SELECT * FROM TimelineItems WHERE ItemId ='9016504235'
The following columns can be used to create a new record:
Title, CustomActivityId, Content, Timestamp, ItemId
The following pseudo-columns can be used to create a new record:
Summary, Location, Phone, Url, TimeRangeStartTimestamp, TimeRangeEndTimestamp
INSERT INTO TimelineItems(ItemId, CustomActivityId, Location, Title, Summary, Content, Timestamp, TimeRangeStartTimestamp, TimeRangeEndTimestamp, phone, url) VALUES ( '7832826517', '8baadd0b-5b64-4ecb-a035-1f5824507f98', 'X', 'Migrated Timeline', 'Works summary', 'Test', '2024-06-06T18:00:30Z', '2024-04-06T15:00:30Z', '2024-05-06T19:00:30Z', '1234-5678', 'https://www.test.com');
You can delete entries by specifying the following column:
Id
DELETE FROM TimelineItems WHERE Id='2b748808-9311-4f76-80de-49baac5609e1'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The timeline item's unique identifier. | |
| Type | String | True |
The timeline item's type. | |
| Title | String | True |
The title of the timeline item. | |
| CustomActivityId | String | True |
The external ID of the custom activity of the timeline item. | |
| Content | String | True |
The item content. | |
| Timestamp | Datetime | True |
The creation time of the event. | |
| UserId | String | True |
The unique identifier of the user who created the timeline item. | |
| UserName | String | True |
The name of the user who created the timeline item. | |
| ItemId | String | True |
The unique identifier of the item that the timeline item is on. | |
| BoardId | String | True |
The unique identifier of the board that the timeline item is on. | |
| BoardName | String | True |
The name of the board that the timeline item is on. | |
| BoardWorkspaceId | String | True |
The unique identifier of the workspace that the timeline item is on. | |
| BoardWorkspaceName | String | True |
The name of the workspace that the timeline item is on. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| Summary | String |
The item summary. |
| Location | String |
Location field value. |
| Phone | String |
Phone number field value. |
| Url | String |
URL field value. |
| TimeRangeStartTimestamp | Datetime |
The time range's start. |
| TimeRangeEndTimestamp | Datetime |
The time range's end. |
Fetches a collection of updates, including user comments, status changes, and other activity logs.
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.
For example, the following queries are processed server-side:
SELECT * FROM Updates WHERE Id = '173981152'
SELECT * FROM Updates WHERE Id IN ('173981152','173981153')
SELECT * FROM Updates WHERE ItemId = '1388002886'
SELECT * FROM Updates WHERE ItemId IN ('1388002886','123923141')
SELECT * FROM Updates WHERE BoardId = '1388002765'
SELECT * FROM Updates WHERE BoardUpdatesOnly = true
The following columns can be used to create a new record:
Body, CreatedAt, ItemId
The following pseudo-columns can be used to create a new record:
ParentId, MentionsList (references UpdateMention), UseAppInfo
| Column Name | Type | Description |
| Id | 115tring | The unique identifier of the board, project, team, or user to mention. |
| Type | 115tring | The type of entity to mention. |
You can delete entries by specifying the following column:
Id
DELETE FROM Updates WHERE Id = '2553512994'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The unique identifier for the update, ensuring each update can be individually referenced and tracked in the database. | |
| Body | String | True |
The HTML-formatted content of the update, which may include various HTML tags for styling and media embedding. | |
| CreatedAt | Datetime | True |
The timestamp when the update was first created, providing the exact date and time of its creation. | |
| CreatorId | String | True |
Users.Id |
The unique identifier of the user who created the update, enabling tracking of authorship and accountability. |
| ItemId | String | True |
The unique identifier for the item associated with the update, linking it to the corresponding item in the database. | |
| PinnedToTopItemIds | String | True |
A comma-separated list of item IDs where the update is pinned, ensuring visibility by keeping it at the top of the list. | |
| TextBody | String | True |
The plain-text content of the update, providing the core message without any HTML formatting. | |
| UpdatedAt | Datetime | True |
The timestamp when the update was last modified, tracking any subsequent changes after the original creation. | |
| EditedAt | Datetime | True |
The date the update's body was last edited. | |
| AssetsIds | String | True |
Assets.Id |
A comma-separated list of unique identifiers for the files or assets attached to the update, such as images or documents. |
| Replies | String | True |
A list of replies associated with the update, typically stored as a comma-separated list of reply IDs or user responses. | |
| Reactions | String | True |
A data field that tracks user reactions to the update, which can include likes, emojis, or other forms of engagement. | |
| BoardId | String | True |
The unique identifier for the board to which the update belongs, allowing for filtering updates by specific boards or categories. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| ParentId | String |
The unique identifier of the parent update, used for creating threaded discussions or replies related to the original update. |
| MentionsList | String |
The user, team, or board to mention in an update. |
| BoardUpdatesOnly | Bool |
Whether to only include board-level updates. |
| UseAppInfo | Bool |
Whether to use the app's details as the creator of the update. |
Retrieves a collection of users, including their details and roles.
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.
For example, the following queries are processed server-side:
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]')
SELECT * FROM Users WHERE TeamsIds = '915408'
SELECT * FROM Users WHERE NonActive = true
The following columns can be updated:
Name, Phone, Birthday, Email, JoinDate, Location, MobilePhone, Title
The following pseudo-columns can be used to update a record:
Department, BypassConfirmationForClaimedDomains, RoleName, RoleId
UPDATE Users SET Name = 'AnotherName' WHERE Id = '5549166043'
UPDATE Users SET RoleName = 'ADMIN' WHERE Id = '5549166043'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The unique identifier for the user, used to reference the user across the system. | |
| TeamsIds | String | True |
Teams.Id |
A list of unique identifiers for the teams the user belongs to, helping to track user membership within teams. |
| Name | String | False |
The full name of the user, used for identification and display purposes. | |
| Phone | String | False |
The user's primary phone number, used for contact and verification. | |
| Birthday | Date | False |
The user's birthdate, which can be used for age verification or personalization. | |
| CurrentLanguage | String | True |
The language currently selected by the user for their interface preferences. | |
| CountryCode | String | True |
The two-letter country code of the user's location, based on their country of residence. | |
| CreatedAt | Datetime | True |
The timestamp for when the user account was created, used for tracking account age and activity. | |
| LastActivity | Datetime | True |
The most recent date and time when the user was active, providing insight into user engagement. | |
| String | False |
The user's email address, used for communication, notifications, and account recovery. | ||
| Enabled | Bool | True |
Indicates whether the user account is currently active and able to perform actions. | |
| IsAdmin | Bool | True |
Indicates if the user has administrative privileges and can manage account settings and users. | |
| IsGuest | Bool | True |
Indicates if the user has guest access, typically with restricted permissions. | |
| IsPending | Bool | True |
Indicates whether the user account is pending approval or activation. | |
| IsVerified | Bool | True |
Indicates if the user has verified their email address, confirming their identity. | |
| IsViewOnly | Bool | True |
Indicates if the user has view-only access, meaning they can view but not modify data. | |
| JoinDate | Date | False |
The date when the user first joined the account, useful for understanding user tenure. | |
| Location | String | False |
The geographic location of the user, which may affect settings like time zone or language. | |
| MobilePhone | String | False |
The user's mobile phone number, used for notifications or secondary contact. | |
| PhotoOriginal | String | True |
The URL for the user's photo in its original size, typically used in larger display contexts. | |
| PhotoSmall | String | True |
The URL for the user's photo in a smaller size (150x150), suitable for smaller profile views. | |
| PhotoThumb | String | True |
The URL for the user's thumbnail photo (100x100), used in list views and smaller displays. | |
| PhotoThumbSmall | String | True |
The URL for the user's small thumbnail photo (50x50), typically used for icons or minimal views. | |
| PhotoTiny | String | True |
The URL for the user's tiny photo (30x30), used for extremely small icons or visual references. | |
| TimeZoneIdentifier | String | True |
The user's time zone identifier, used for scheduling and displaying time-related information. | |
| Title | String | False |
The user's job title or designation, providing context about their role within the organization. | |
| Url | String | True |
The URL to the user's profile page, typically used for linking to the user's detailed information. | |
| UtcHoursDiff | Int | True |
The difference in hours between the user's local time and UTC, used for adjusting timestamps and scheduling. | |
| SignUpProductKind | String | True |
The product or service that the user initially signed up for, helping to categorize user plans. | |
| AccountFirstDayOfTheWeek | String | True |
The day of the week (Sunday or Monday) designated as the start of the week for the account, affecting calendar views. | |
| AccountId | String | True |
The unique identifier for the account to which the user belongs, used to associate users with specific accounts. | |
| AccountLogo | String | True |
The URL for the account's logo, displayed in the UI to represent the account. | |
| AccountName | String | True |
The name of the account, used to identify the account in the system. | |
| AccountPlanMaxUsers | Int | True |
The maximum number of users allowed under the current account plan, indicating the plan's user capacity. | |
| AccountPlanPeriod | String | True |
The duration of the account's plan (for example, monthly, annually), which helps track billing cycles. | |
| AccountPlanTier | String | True |
The tier of the account's subscription plan (for example, Basic, Premium), defining the features available. | |
| AccountPlanVersion | Int | True |
The version number of the current plan, useful for tracking plan changes over time. | |
| AccountShowTimelineWeekends | Bool | True |
Indicates whether weekends are included in the account's timeline views. | |
| AccountSlug | String | True |
A URL-friendly version of the account name, typically used for the account's web address or identifier. | |
| AccountTier | String | True |
The account's subscription tier, which determines available features and limitations. | |
| AccountCountryCode | String | True |
The two-letter ISO 3166 country code for the account's registered country, helping to localize settings. | |
| AccountSignUpProductKind | String | True |
The product or service the account initially signed up for, which may determine the account's default settings. | |
| AccountProducts | String | True |
A list of active products or services associated with the account, showing the account's current offerings. | |
| OutOfOfficeActive | Bool | True |
Indicates whether the user's out-of-office status is currently active, affecting their availability. | |
| OutOfOfficeDisableNotifications | Bool | True |
Indicates if notifications are disabled while the user is out of office. | |
| OutOfOfficeStartDate | Date | True |
The date when the user's out-of-office status began, marking the start of their absence. | |
| OutOfOfficeEndDate | Date | True |
The date when the user's out-of-office status ends, marking the return to active status. | |
| OutOfOfficeType | String | True |
The type of out-of-office status, such as vacation or personal leave, used to specify the reason for absence. | |
| NonActive | Bool | True |
Indicates whether non-active users should be included in account queries, useful for generating reports on inactive users. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| Department | String |
The department of the user. |
| BypassConfirmationForClaimedDomains | Bool |
Whether to bypass email confirmation for claimed domains. |
| RoleName | String |
The user's updated role. 使用できる値は次のとおりです。GUEST, VIEW_ONLY, MEMBER, ADMIN |
Fetches a collection of webhooks, including their configuration and associated 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.
For example, the following queries are processed server-side:
SELECT * FROM Webhooks WHERE BoardId = '5574930939'
SELECT * FROM Webhooks WHERE AppWebhooksOnly = true
The following columns can be used to create a new record:
BoardId, Config, Event
The following pseudo-column can be used to create a new record:
Url
INSERT INTO Webhooks (BoardId,Config,Event,Url) VALUES ('5574930939','{\"columnId\":\"status\", \"columnValue\":{\"$any$\":true}}','change_status_column_value','https://test.com/')
You can delete entries by specifying the following column:
Id
DELETE FROM Webhooks WHERE Id = '242031214'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The unique identifier for the webhook, used to distinguish it from other webhooks in the system. | |
| BoardId | String | True |
The unique identifier for the board associated with the webhook, helping to identify which board the webhook is tied to. | |
| Config | String | True |
A JSON or similar configuration format detailing the settings and preferences for the webhook, including event types, filters, and other parameters. | |
| Event | String | True |
The specific event or trigger that the webhook listens to, such as a change in status or a new task being created. 使用できる値は次のとおりです。change_column_value, create_column, change_status_column_value, change_subitem_column_value, change_specific_column_value, create_item, create_subitem, create_update, edit_update, delete_update, create_subitem_update, change_subitem_name, change_name, item_deleted, subitem_deleted, item_archived, subitem_archived, item_restored, item_moved_to_any_group, item_moved_to_specific_group, move_subitem | |
| AppWebhooksOnly | Bool | True |
A filter to include only webhooks created by the application initiating the request, excluding any manually created or external webhooks. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| Url | String |
The URL to which the webhook sends its notifications, typically used to deliver event data to a specified endpoint. |
Get a collection of question for the specified formToken.
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.
For example, the following query is processed server-side:
SELECT * FROM WorkformQuestions WHERE Token = 'Val1'
The following columns can be used to create a new record:
Token, Description, Options, Required, Title, Type, Visible, SettingsCheckedByDefault, SettingsDefaultCurrentDate, SettingsDisplay, SettingsIncludeTime, SettingsLimit, SettingsLocationAutofilled, SettingsOptionsOrder, SettingsPrefillEnabled, SettingsPrefillLookup, SettingsPrefillSource, SettingsPrefixAutofilled, SettingsPrefixPredefinedEnabled, SettingsPrefixPredefinedPrefix, SettingsSkipValidation
The following columns can be updated:
Description, Required, Title, Type, Visible, SettingsCheckedByDefault, SettingsDefaultCurrentDate, SettingsDisplay, SettingsIncludeTime, SettingsLimit, SettingsLocationAutofilled, SettingsOptionsOrder, SettingsPrefillEnabled, SettingsPrefillLookup, SettingsPrefillSource, SettingsPrefixAutofilled, SettingsPrefixPredefinedEnabled, SettingsPrefixPredefinedPrefix, SettingsSkipValidation
You can delete entries by specifying the following columns:
Id, Token
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The question's unique identifier. | |
| Token [KEY] | String | True |
The form's string-based unique token. | |
| Description | String | False |
Optional text providing additional context, instructions, or examples for the question. | |
| Options | String | True |
The available options for choice-based questions. | |
| Required | Bool | False |
Whether the question must be answered to submit the form. | |
| ShowIfRules | String | True |
Conditional logic rules that determine whether the question is displayed, based on responses to other questions. | |
| Title | String | False |
The question's title. | |
| Type | String | False |
The question's type. Determines input behavior and validation. | |
| Visible | Bool | False |
Whether the question is visible to responders. | |
| SettingsCheckedByDefault | Bool | False |
Whether the box should be checked by default. | |
| SettingsDefaultCurrentDate | Bool | False |
Whether the current date is set as the default value. | |
| SettingsDisplay | String | False |
The display options for select-type questions. | |
| SettingsIncludeTime | Bool | False |
Whether the time selection (hours and minutes) is included with the date selector. | |
| SettingsLimit | Int | False |
The maximum rating value that can be selected. | |
| SettingsLocationAutofilled | Bool | False |
Whether the responder's location is automatically detected and filled. | |
| SettingsOptionsOrder | String | False |
The ordering options for select questions. | |
| SettingsPrefillEnabled | Bool | False |
Whether the question's prefill functionality is enabled. | |
| SettingsPrefillLookup | String | False |
The field or parameter name to lookup from the prefill source. | |
| SettingsPrefillSource | String | False |
The sources for prefilling question values. | |
| SettingsPrefixAutofilled | Bool | False |
Whether the phone country prefix is automatically detected and filled. | |
| SettingsPrefixPredefinedEnabled | Bool | False |
Whether a pre-defined phone country prefix is enabled for phone number questions. | |
| SettingsPrefixPredefinedPrefix | String | False |
The predefined phone country prefix in capital letters. | |
| SettingsSkipValidation | Bool | False |
Whether URL format validation is skipped, allowing any text input. |
Get a collection of forms.
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.
For example, the following query is processed server-side:
SELECT * FROM Workforms WHERE Token = 'Val1'
The following column can be used to create a new record:
The following pseudo-columns can be used to create a new record:
BoardKind, BoardOwnerIds, BoardOwnerTeamIds, BoardSubscriberIds, BoardSubscriberTeamsIds, DestinationFolderId, DestinationFolderName, DestinationName, DestinationWorkspaceId
The following columns can be updated:
AccessibilityLanguage, AccessibilityLogoAltText, Description, Title, AppearanceHideBranding, AppearancePrimaryColor, AppearanceShowProgressBar, AppearanceSubmitButton, AppearanceTextColor, AppearanceTextFont, AppearanceTextSize, AppearanceBackgroundType, AppearanceBackgroundValue, AppearanceLayoutAlignment, AppearanceLayoutDirection, AppearanceLayoutFormFormat, AppearanceFormLogoPosition, AppearanceFormLogoSize, FeaturesDraftSubmissionEnabled, FeaturesIsInternal, FeaturesPasswordEnabled, FeaturesReCaptchaChallenge, FeaturesAfterSubmissionViewAllowEditSubmission, FeaturesAfterSubmissionViewAllowResubmit, FeaturesAfterSubmissionViewAllowViewSubmission, FeaturesAfterSubmissionViewDescription, FeaturesAfterSubmissionViewRedirectAfterSubmissionEnabled, FeaturesAfterSubmissionViewRedirectAfterSubmissionRedirectURL, FeaturesAfterSubmissionViewShowSuccessImage, FeaturesAfterSubmissionViewTitle, FeaturesCloseDate, FeaturesCloseDateEnabled, FeaturesMondayIncludeNameQuestion, FeaturesMondayIncludeUpdateQuestion, FeaturesMondayItemGroupId, FeaturesMondaySyncQuestionAndColumnsTitles, FeaturesPreSubmissionViewDescription, FeaturesPreSubmissionViewEnabled, FeaturesPreSubmissionViewStartButton, FeaturesPreSubmissionViewTitle, FeaturesRequireLoginEnabled, FeaturesRequireLoginRedirectToLogin, FeaturesResponseLimit, FeaturesResponseLimitEnabled, FeaturesShortenedLinkEnabled, FeaturesShortenedLinkURL
The following pseudo-columns can be used to update a record:
Questions, Password
| Name | Type | ReadOnly | References | Description |
| Id | Int | True |
The form's unique board view identifier. | |
| Token [KEY] | String | True |
The form's string-based unique token. | |
| AccessibilityLanguage | String | False |
The language code for the form's localization and interface text. | |
| AccessibilityLogoAltText | String | False |
The form's logo image alternative text description. | |
| Active | Bool | True |
Whether the form is visible and accepting responses. | |
| BuiltWithAI | Bool | True |
Whether the form was created with monday.com’s AI-assisted form builder. | |
| Description | String | False |
The optional form description, displayed below the title. | |
| IsAnonymous | Bool | True |
Whether responses are collected anonymously. | |
| OwnerId | Int | True |
The user ID of the form's owner/creator. | |
| Title | String | False |
Title displayed at the top of the form. | |
| Type | String | True |
The form's type. | |
| AppearanceHideBranding | Bool | False |
Whether monday.com branding is hidden. | |
| AppearancePrimaryColor | String | False |
The HEX color code of the primary theme color used in the form. | |
| AppearanceShowProgressBar | Bool | False |
Whether an indicator showing the form's completion progress bar is displayed. | |
| AppearanceSubmitButton | String | False |
The custom text displayed on the form's submit button. | |
| AppearanceTextColor | String | False |
The form's text HEX color code. | |
| AppearanceTextFont | String | False |
The form's font family. | |
| AppearanceTextSize | String | False |
The form's base text size. | |
| AppearanceBackgroundType | String | False |
The form's background type. | |
| AppearanceBackgroundValue | String | False |
The form's background value. | |
| AppearanceLayoutAlignment | String | False |
The form's text and content alignment. | |
| AppearanceLayoutDirection | String | False |
The form's reading direction. | |
| AppearanceLayoutFormFormat | String | False |
The form's display format. | |
| AppearanceFormLogoPosition | String | False |
The form's logo placement. | |
| AppearanceFormLogoSize | String | False |
The form's logo size. | |
| FeaturesDraftSubmissionEnabled | Bool | False |
Whether users are allowed to save incomplete responses as drafts. | |
| FeaturesIsInternal | Bool | False |
Whether the form is restricted to internal users only. | |
| FeaturesPasswordEnabled | Bool | False |
Whether users must enter a password to access the form. | |
| FeaturesReCaptchaChallenge | Bool | False |
Whether the form has reCAPTCHA verification enabled to prevent spam submissions. | |
| FeaturesAfterSubmissionViewAllowEditSubmission | Bool | False |
Whether users can edit their responses after submission. | |
| FeaturesAfterSubmissionViewAllowResubmit | Bool | False |
Whether users can submit multiple responses to the same form. | |
| FeaturesAfterSubmissionViewAllowViewSubmission | Bool | False |
Whether users can view their answers after submission. | |
| FeaturesAfterSubmissionViewDescription | String | False |
The text displayed after form submission. | |
| FeaturesAfterSubmissionViewRedirectAfterSubmissionEnabled | Bool | False |
Whether responders are automatically redirected to a specified URL after form completion. | |
| FeaturesAfterSubmissionViewRedirectAfterSubmissionRedirectURL | String | False |
The URL where users will be redirected after successfully submitting the form. | |
| FeaturesAfterSubmissionViewShowSuccessImage | Bool | False |
Whether a success image appears after form submission. | |
| FeaturesAfterSubmissionViewTitle | String | False |
The title text displayed after form submission. | |
| FeaturesCloseDate | Datetime | False |
The ISO 8601 timestamp when the form will automatically stop accepting responses. | |
| FeaturesCloseDateEnabled | Bool | False |
Whether the form automatically closes at a specified date and time. | |
| FeaturesMondayIncludeNameQuestion | Bool | False |
Whether a name question is added to the form. | |
| FeaturesMondayIncludeUpdateQuestion | Bool | False |
Whether an update field is added to the form. | |
| FeaturesMondayItemGroupId | String | False |
The board group ID where new items will be created from form responses. | |
| FeaturesMondaySyncQuestionAndColumnsTitles | Bool | False |
Whether the form question title syncs with the board column name. | |
| FeaturesPreSubmissionViewDescription | String | False |
The text displayed on the welcome screen (e.g., extra context, instructions). | |
| FeaturesPreSubmissionViewEnabled | Bool | False |
Whether a welcome screen is displayed before starting the form. | |
| FeaturesPreSubmissionViewStartButton | String | False |
An object containing the form's welcome screen start button configuration. | |
| FeaturesPreSubmissionViewTitle | String | False |
The title text displayed on the welcome screen. | |
| FeaturesRequireLoginEnabled | Bool | False |
Whether the form requires users to log in before submitting responses. | |
| FeaturesRequireLoginRedirectToLogin | Bool | False |
Whether unauthenticated users are automatically redirected to the login page. | |
| FeaturesResponseLimit | Int | False |
The maximum number of form responses allowed. | |
| FeaturesResponseLimitEnabled | Bool | False |
Whether the form's response limits are enabled. | |
| FeaturesShortenedLinkEnabled | Bool | False |
Whether shortened URLs can be generated. | |
| FeaturesShortenedLinkURL | String | False |
The form's generated, shortened URL. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| BoardKind | String |
The type of board. 使用できる値は次のとおりです。public, private, share |
| BoardOwnerIds | String |
The user IDs of the users who will be owners of the board that stores the form responses. |
| BoardOwnerTeamIds | String |
The team IDs of the teams whose members will be owners of the board that stores the form responses. |
| BoardSubscriberIds | String |
The user IDs of the users who will be subscribed to the board that stores the form responses. |
| BoardSubscriberTeamsIds | String |
The team IDs of the teams whose members will be subscribed to the board that stores the form responses. |
| DestinationFolderId | String |
The unique identifier of the folder to create the form in. |
| DestinationFolderName | String |
The name of the folder to create the form in. |
| DestinationName | String |
The name of the board that will be created to store the form responses. |
| DestinationWorkspaceId | String |
The unique identifier of the workspace to create the form in. |
| Questions | String |
An ordered array of all question IDs in the form. |
| Password | String |
The form's password. Must be at least one character long. |
Get a collection of tags for the specified formToken.
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.
For example, the following query is processed server-side:
SELECT * FROM WorkformTags WHERE Token = 'Val1'
The following columns can be used to create a new record:
Token, Name, Value
The following column can be updated:
Value
You can delete entries by specifying the following columns:
Id, Token
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The tag's unique identifier. | |
| Token [KEY] | String | True |
The form's string-based unique token. | |
| ColumnId | String | True |
The unique identifier of the column the tag is associated with. | |
| Name | String | True |
The tag's name. | |
| Value | String | False |
The tag's value. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| DeleteAssociatedColumn | Bool |
Whether the associated column should be deleted. |
Retrieves a collection of workspaces, including their names and details.
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.
For example, the following queries are processed server-side:
SELECT * FROM Workspaces WHERE Id = '3578971'
SELECT * FROM Workspaces WHERE Id IN ('3578971','3578972')
SELECT * FROM Workspaces WHERE Kind = 'open'
SELECT * FROM Workspaces WHERE State = 'active'
The following columns can be used to create a new record:
Description, Kind, Name, AccountProductId
INSERT INTO Workspaces (Name,Kind,Description,AccountProductId) VALUES ('New Workspace','open','This is my new workspace.','1244553456')
The following columns can be updated:
Description, Kind, Name, AccountProductId
UPDATE Workspaces SET Description = 'testDescription', Name = 'testName', Kind = 'open', AccountProductId='1244553456' WHERE Id = '3819431'
You can delete entries by specifying the following column:
Id
DELETE FROM Workspaces WHERE Id = '3819431'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The unique identifier for the workspace, used to distinguish it from other workspaces within the platform. | |
| Description | String | False |
A brief textual description of the workspace, providing context or details about its purpose or contents. | |
| Kind | String | False |
Indicates whether the workspace is currently open or closed, helping to categorize the workspace's availability. 使用できる値は次のとおりです。open, closed | |
| Name | String | False |
The name assigned to the workspace, typically used for identification in the user interface. | |
| State | String | True |
Describes the current state of the workspace, which can be 'all', 'active', 'archived', or 'deleted', indicating its lifecycle status. | |
| CreatedAt | Datetime | True |
The timestamp representing when the workspace was initially created, useful for auditing and time-based queries. | |
| AccountProductId | String | False |
The identifier for the specific product associated with the account, linking the workspace to its product type or plan. | |
| AccountProductKind | String | True |
Specifies the type of product tied to the account, such as core, marketing, CRM, software, project management, forms, or whiteboard. | |
| SettingsIconColor | String | True |
The color code (in hex format) used as the background color for the workspace's icon, allowing for customization in the user interface. | |
| SettingsIconImage | String | True |
A URL pointing to the image used as the workspace's icon. If the image is uploaded by the user, the URL is temporary and needs to be refreshed periodically. The first letter of the workspace name is used as a fallback when the image is not available. | |
| IsDefaultWorkspace | String | True |
Indicates whether this workspace is set as the default for the account or product, which may affect the user's experience and default settings. | |
| ItemURL | String | True |
The URL associated with the workspace, providing direct access or linking to resources or data within the workspace. |
Retrieves the list of teams subscribed to a specific 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.
For example, the following queries are processed server-side:
SELECT * FROM WorkspaceTeams WHERE WorkspaceId = '3820334'
SELECT * FROM WorkspaceTeams WHERE Kind = 'owner'
Note: API limitations may cause affected row counts or generated keys to be reported inaccurately when attempting to create relationships between entities that are already related.
The following columns can be used to create a new record:
Id, WorkspaceId, Kind
INSERT INTO WorkspaceTeams (Id,WorkspaceId,Kind) VALUES ('961021','3820334','subscriber')
INSERT INTO WorkspaceTeams (Id,WorkspaceId,Kind) VALUES ('961021','3820334','owner')
You can delete entries by specifying the following columns:
Id, WorkspaceId
DELETE FROM WorkspaceTeams WHERE Id = '961021' AND WorkspaceId = '3820334'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The unique identifier for the team, used to distinguish each team within the system. This ID is referenced in other tables or operations to identify the specific team. | |
| WorkspaceId [KEY] | String | True |
The unique identifier for the workspace to which the team belongs. It is used to associate the team with a specific workspace for collaboration or access control purposes. | |
| Kind | String | True |
Defines the team’s role within the workspace. The role can be 'subscriber' or 'owner', where owners have additional permissions compared to subscribers. This column is useful for filtering and managing access levels. 使用できる値は次のとおりです。owner, subscriber |
Fetches the list of users subscribed to a specific 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.
For example, the following queries are processed server-side:
SELECT * FROM WorkspaceUsers WHERE WorkspaceId = '3578971'
SELECT * FROM WorkspaceUsers WHERE Kind = 'owner'
This table supports BATCH INSERT. The following columns can be used to create a new record:
Id, WorkspaceId, Kind
INSERT INTO WorkspaceUsers (Id, WorkspaceId, Kind) VALUES ('51688059', '3820334', 'subscriber')
Note: API limitations may cause affected row counts or generated keys to be reported inaccurately when attempting to create relationships between entities that are already related.
This table supports BATCH DELETE. You can delete entries by specifying the following columns:
Id, WorkspaceId
DELETE FROM WorkspaceUsers WHERE Id = '51688059' AND WorkspaceId = '3820334'
DELETE FROM WorkspaceUsers WHERE EXISTS SELECT Id, WorkspaceId FROM WorkspaceUsers#TEMP
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The unique identifier assigned to each user, used to distinguish between different users within the system. | |
| WorkspaceId [KEY] | String | True |
The unique identifier for the workspace to which the user belongs, linking the user to a specific workspace or project. | |
| Kind | String | True |
The role assigned to the user within the workspace, such as 'subscriber' or 'owner.' All users with the 'owner' role are automatically granted 'subscriber' privileges. This field can be used to filter or identify users with specific roles, like non-owners. 使用できる値は次のとおりです。owner, subscriber |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
| Name | Description |
| AccountProducts | Retrieve information about the account's active products. |
| AccountRoles | Retrieve metadata about an account's default and custom user roles. |
| ActivityLogs | Fetches the activity log events associated with a specific board, detailing recent updates and actions. |
| AppCollaborators | Get all app collaborators. |
| Assets | Retrieves a collection of assets based on provided asset IDs, such as files or media associated with items. |
| AuditEventCatalogues | Get a list of all supported audit log events. |
| ColumnTypeSchema | The schema for a specific column type. |
| PlatformUsageByApp | Breakdown of API usage for the top six apps over the past 14 days. This table is available only with a Monday Enterprise account. |
| PlatformUsageByDay | Breakdown of API usage per day over the past 14 days. This table is available only with a Monday Enterprise account. |
| PlatformUsageByUser | Breakdown of API usage for the top six users over the past 14 days. This table is available only with a Monday Enterprise account. |
| UpdateViewers | Retrieves the viewers associated with updates. |
Retrieve information about the account's active products.
The Sync App processes all filters client-side within the Sync App. The following query is the only one processed server-side:
SELECT * FROM AccountProducts
| Name | Type | References | Description |
| Id [KEY] | String | The account product id | |
| AccountId | String | The account id. | |
| Kind | String | The account product kind. | |
| DefaultWorkspaceId | String | The account product default workspace id |
Retrieve metadata about an account's default and custom user roles.
The Sync App processes all filters client-side within the Sync App. The following query is the only one processed server-side:
SELECT * FROM AccountRoles
| Name | Type | References | Description |
| Id | String | The ID of the role. | |
| Name | String | The name of the role. | |
| Type | String | The type of the role. |
Fetches the activity log events associated with a specific board, detailing recent updates and actions.
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.
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 unique identifier of the activity log event, used to track and retrieve specific log entries. | |
| BoardId | String |
Boards.id | The unique identifier of the board associated with the activity, providing context for the event. |
| AccountId | String | The unique identifier of the account that initiated the activity, useful for auditing and tracking purposes. | |
| UserId | String |
Users.Id | The unique identifier of the user who triggered the activity, enabling user-specific analysis and reporting. |
| CreatedAt | Datetime | The timestamp indicating when the activity event occurred, formatted in datetime. | |
| Data | String | A serialized string representation of the item's column values at the time of the event. | |
| Entity | String | Specifies the entity affected by the event, such as a 'pulse' (task) or 'board' (project). | |
| Event | String | Describes the specific action that occurred, such as an Update, Delete, or Create operation. | |
| ColumnId | String | The unique identifier of the column affected by the activity, used for filtering and analysis. | |
| GroupId | String |
Groups.Id | The unique identifier of the group within the board affected by the activity, used for context or filtering. |
| ItemId | String | The unique identifier of the item (task or object) within the board affected by the activity, used for detailed tracking and filtering. |
Get all app collaborators.
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.
For example, the following queries are processed server-side:
SELECT * FROM AppCollaborators WHERE AppId = '10483971'
SELECT * FROM AppCollaborators WHERE AppId IN ('10483971', '10483972')
| Name | Type | References | Description |
| AppId [KEY] | String | The app's unique identifier. | |
| Id [KEY] | String | The user's unique identifier. | |
| 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. | |
| 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. | |
| Location | String | The user's location. | |
| MobilePhone | String | The user's mobile phone number. | |
| Title | String | The user's title. | |
| Url | String | The user's profile url. |
Retrieves a collection of assets based on provided asset IDs, such as files or media associated with items.
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.
For example, the following query is processed server-side:
SELECT * FROM Assets WHERE Id = 'Val1'
| Name | Type | References | Description |
| Id [KEY] | String | The unique identifier assigned to the file in the system for tracking and referencing purposes. | |
| Name | String | The name of the file, as specified during upload or creation. | |
| CreatedAt | Datetime | The date and time when the file was created or uploaded, stored in datetime format. | |
| FileExtension | String | The file extension indicating the format or type of the file, such as '.jpg', '.png', or '.pdf'. | |
| FileSize | Int | The size of the file in bytes, providing an indication of storage usage. | |
| OriginalGeometry | String | The original dimensions or geometry of the asset, typically used for images or spatial files. | |
| PublicUrl | String | A temporary public URL to access the asset directly. The URL is valid for 1 hour after being generated. | |
| UploadedById | String |
Users.Id | The unique identifier of the user who uploaded the file to the system. |
| Url | String | The URL to access and view the asset directly in its original form. | |
| UrlThumbnail | String | The URL to access and view the asset as a thumbnail. This is only available for image files. |
Get a list of all supported audit log events.
The Sync App processes all filters client-side within the Sync App. The following query is the only one processed server-side:
SELECT * FROM AuditEventCatalogues
| Name | Type | References | Description |
| Description | String | The audit log event's description. | |
| MetadataDetails | String | The audit log event's metadata. | |
| Name | String | The audit log event's description. |
The schema for a specific column type.
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.
For example, the following query is processed server-side:
SELECT * FROM ColumnTypeSchema WHERE Type = 'auto_number'
SELECT * FROM ColumnTypeSchema WHERE Type IN ('auto_number','board-relation')
| Name | Type | References | Description |
| JSON | String | The column schema JSON object. | |
| Type [KEY] | String | The type of the column.
使用できる値は次のとおりです。auto_number, board_relation, button, checkbox, color_picker, country, creation_log, date, dependency, doc, dropdown, email, file, formula, group, hour, integration, item_assignees, item_id, last_updated, link, location, long_text, mirror, name, numbers, people, person, phone, progress, rating, status, subtasks, tags, team, text, time_tracking, timeline, unsupported, vote, week, world_clock |
Breakdown of API usage for the top six apps over the past 14 days. This table is available only with a Monday Enterprise account.
The Sync App processes all filters client-side within the Sync App. The following query is the only one processed server-side:
SELECT * FROM PlatformUsageByApp
| Name | Type | References | Description |
| AppId | String |
Apps.Id | The app unique identifier |
| ApiAppId | String | The app's unique API consumer identifier. | |
| Usage | Int | The API amount consumed by a given app in the past 14 days. | |
| LastUpdated | Datetime | The timestamp when the usage data was last updated. | |
| BaseLimit | Int | The base daily limit for API usage. | |
| TotalLimit | Int | The total daily limit for API usage. |
Breakdown of API usage per day over the past 14 days. This table is available only with a Monday Enterprise account.
The Sync App processes all filters client-side within the Sync App. The following query is the only one processed server-side:
SELECT * FROM PlatformUsageByDay
| Name | Type | References | Description |
| Day | String | The name of the day. | |
| Usage | Int | The amount consumed on a given day. | |
| LastUpdated | Datetime | The timestamp when the usage data was last updated. | |
| BaseLimit | Int | The base daily limit for API usage. | |
| TotalLimit | Int | The total daily limit for API usage. |
Breakdown of API usage for the top six users over the past 14 days. This table is available only with a Monday Enterprise account.
The Sync App processes all filters client-side within the Sync App. The following query is the only one processed server-side:
SELECT * FROM PlatformUsageByUser
| Name | Type | References | Description |
| UserId | String |
Users.Id | The user identifier. |
| Usage | Int | The API amount consumed by a given user in the past 14 days. | |
| LastUpdated | Datetime | The timestamp when the usage data was last updated. | |
| BaseLimit | Int | The base daily limit for API usage. | |
| TotalLimit | Int | The total daily limit for API usage. |
Retrieves the viewers associated with 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.
For example, the following queries are processed server-side:
SELECT * FROM UpdateViewers WHERE UpdateId = '3578971'
SELECT * FROM UpdateViewers WHERE UpdateId IN ('173981152','173981153')
| Name | Type | References | Description |
| Id [KEY] | String | The viewer's unique identifier. | |
| Medium | String | The channel through which the user views the update. | |
| UpdateId [KEY] | String |
Updates.Id | The update's unique identifier. |
ストアドプロシージャはファンクションライクなインターフェースで、Monday の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずSync App の機能を拡張します。
ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにMonday から関連するレスポンスデータを返します。
| Name | Description |
| AddContentToDocFromMarkdown | Adds markdown content to an existing document by converting it into document blocks. |
| AddFileToColumn | Attaches a file to a specific column value in a board, enhancing item detail management. |
| AddFileToUpdate | Uploads and associates a file with a specific update in Monday. |
| BatchExtendTrialPeriod | Extends the trial period of an application for multiple selected accounts simultaneously. |
| ChangeColumnMetadata | Change a column's properties. |
| ClearItemUpdates | Clears updates associated with a specific item on a board. |
| CreateColumn | Create a new column in a board. |
| CreateDocBlock | Creates a new content block within a document in Monday. |
| CreateDocBoard | Creates a new document within a board. |
| CreateNotification | Sends a new notification to users, detailing specific events or updates. |
| DeleteColumn | Delete a column. |
| DuplicateBoard | Creates a duplicate of an existing board, including its items, columns, and structure. |
| DuplicateDoc | Duplicate a document. |
| DuplicateGroup | Duplicates an existing group within a board. |
| DuplicateItem | Duplicates an item within a board, including its associated data. |
| GetAccount | Retrieve information about the connected account. |
| LikeUpdate | Adds a 'like' to a specific update, indicating approval or acknowledgment. |
| MoveItemToBoard | Moves an item from its current board to a different board, transferring all associated data. |
| PinUpdate | Pins a specific update, keeping it at the top of the update list for better visibility. |
| RemoveMockAppSubscription | Removes a mock app subscription for the current account, typically used for testing purposes. |
| SetMockAppSubscription | Sets a mock app subscription for the current account, enabling testing scenarios. |
| UnpinUpdate | Unpins a previously pinned update, allowing it to return to its chronological position. |
| UpdateBoardHierarchy | Update a board's position, workspace, or product. |
Adds markdown content to an existing document by converting it into document blocks.
| Name | Type | Required | Description |
| DocId | String | True | The unique identifier of the doc to add the content to. |
| AfterBlockId | String | False | The unique identifier of the block to insert the markdown content after. |
| Markdown | String | True | The markdown content to add and convert. |
| Name | Type | Description |
| Success | Boolean | Indicates whether or not the operation executed successfully. |
| Details | String | Any extra details on the operation's execution. |
| BlockId | String | The document block's unique identifier. |
Attaches a file to a specific column value in a board, enhancing item detail management.
| Name | Type | Required | Description |
| ItemId | String | True | Specifies the unique identifier of the item to which the file will be attached. This should correspond to an existing item in the database. |
| ColumnId | String | True | Specifies the unique identifier of the column where the file will be added. The column must exist and be associated with the specified item. |
| FileName | String | False | Specifies the name of the file being uploaded. This is required when the file's content is provided via the Content input parameter. |
| LocalPath | String | False | Specifies the local file path of the file to be uploaded. Use this when the file content is being uploaded from a local source. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the file was successfully uploaded and attached to the specified column. |
| Details | String | Provides additional information about the execution of the operation, such as warnings or errors encountered. |
| AssetId | String | Returns the unique identifier (Asset ID) assigned to the uploaded file for future reference. |
Uploads and associates a file with a specific update in Monday.
| Name | Type | Required | Description |
| UpdateId | String | True | Specifies the unique identifier (ID) of the update to which the file should be added. |
| FileName | String | False | Specifies the name of the file being added. This is required if 'Content' is provided. |
| LocalPath | String | False | Specifies the local file path of the file to be uploaded. This is used when 'Content' is not provided. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the file was successfully added to the update. |
| Details | String | Provides additional details about the execution of the operation, such as errors or warnings. |
| AssetId | String | Returns the unique identifier (ID) of the uploaded file for reference. |
Extends the trial period of an application for multiple selected accounts simultaneously.
| Name | Type | Required | Description |
| AccountSlugs | String | True | A comma-separated list of account slugs (unique identifiers for accounts). Maximum allowed: 5. |
| AppId | String | True | The unique identifier (ID) of the application associated with the trial period extension. |
| PlanId | String | True | The unique identifier (ID) of the payment plan linked to the accounts for trial extension. |
| DurationInDays | Integer | True | The number of days by which the trial period should be extended. Maximum allowable extension: 365 days. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the batch operation to extend the trial period was successful. |
| Reason | String | Provides a detailed reason for any error encountered during the batch operation. |
Change a column's properties.
| Name | Type | Required | Description |
| BoardId | String | True | The board's unique identifier. |
| Id | String | True | The column's unique identifier. |
| ColumnProperty | String | True | The property name of the column to be changed (title / description).
使用できる値は次のとおりです。title, description |
| Value | String | False | The new description of the column. |
| Name | Type | Description |
| Success | Boolean | Indicates whether or not the operation executed successfully. |
| Details | String | Any extra details on the operation's execution. |
| Id | String | The column's unique identifier. |
Clears updates associated with a specific item on a board.
| Name | Type | Required | Description |
| ItemId | String | True | Specifies the unique identifier (ID) of the item for which updates are to be cleared. |
| Name | Type | Description |
| Success | Boolean | Returns a boolean indicating whether the operation to clear updates for the specified item was successful. |
| Details | String | Provides additional details or messages about the execution of the operation, such as errors or warnings. |
| ItemId | String | Returns the unique identifier (ID) of the item for which updates were cleared. |
Create a new column in a board.
| Name | Type | Required | Description |
| BoardId | String | True | The board's unique identifier. |
| Title | String | True | The new column's title. |
| Description | String | False | The new column's description. |
| ColumnType | String | True | The type of column to create. |
| Defaults | String | False | The new column's defaults. |
| Id | String | False | The column's user-specified unique identifier. |
| AfterColumnId | String | False | The column's unique identifier after which the new column will be inserted. |
| Name | Type | Description |
| Success | Boolean | Indicates whether or not the operation executed successfully. |
| Details | String | Any extra details on the operation's execution. |
| Id | String | The column's unique identifier. |
Creates a new content block within a document in Monday.
| Name | Type | Required | Description |
| DocId | String | True | Specifies the unique identifier (ID) of the document where the block will be created. |
| AfterBlockId | String | False | Indicates the block ID after which the new block should be inserted. If not provided, the new block is inserted at the beginning of the document. |
| ParentBlockId | String | False | Specifies the ID of the parent block under which the new block will be appended. Used for hierarchical block structures. |
| Type | String | True | Defines the content type of the block, such as text, image, or table.
使用できる値は次のとおりです。board, bulleted_list, check_list, code, divider, image, large_title, layout, medium_title, normal_text, notice_box, numbered_list, quote, small_title, table, video, widget, page_break |
| Content | String | True | Specifies the content to include in the new block, such as text or other media. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the block creation operation was successfully completed. |
| Details | String | Provides additional details about the execution of the block creation operation, including error messages if applicable. |
| DocumentBlockId | String | Returns the unique identifier (ID) of the newly created document block. |
Creates a new document within a board.
| Name | Type | Required | Description |
| ItemId | String | True | The unique identifier for the item being processed, used to reference the specific item in the database for the operation. |
| ColumnId | String | True | The unique identifier for the column being manipulated, allowing the procedure to target a specific column within the table or schema. |
| Name | Type | Description |
| Success | Boolean | A flag indicating whether the operation was successful. A value of true means the operation completed without errors, while false indicates failure. |
| Details | String | A message providing additional information about the operation's execution, useful for debugging or understanding partial successes or failures. |
| DocumentId | String | The unique identifier assigned to the document created or updated by the operation, linking it to the document management system or database. |
Sends a new notification to users, detailing specific events or updates.
| Name | Type | Required | Description |
| Text | String | True | The content of the notification message, providing the information or alert to be sent to the target. |
| UserId | String | True | The unique identifier for the user initiating or receiving the notification, typically used to reference the user's account in the system. |
| TargetId | String | True | The unique identifier for the target object of the notification, which can be a project, post, or another relevant entity. |
| TargetType | String | True | The type of the target object (for example, Project or Post) that the notification pertains to, used to determine the context of the notification.
使用できる値は次のとおりです。Project, Post |
| Name | Type | Description |
| Success | Boolean | A flag indicating the outcome of the operation. A true value signifies that the notification was successfully sent or processed, while false indicates failure. |
| Details | String | Additional information about the operation, such as an error message or context, useful for troubleshooting or understanding the result of the operation. |
| NotificationId | String | The unique identifier for the notification that was created or processed, which can be used to reference or track the notification in the system. |
Delete a column.
| Name | Type | Required | Description |
| BoardId | String | True | The board's unique identifier. |
| Id | String | True | The column's unique identifier. |
| Name | Type | Description |
| Success | Boolean | Indicates whether or not the operation executed successfully. |
| Details | String | Any extra details on the operation's execution. |
| Id | String | The column's unique identifier. |
Downloads a file uploaded to Monday.com by specifying the corresponding asset ID.
| Name | Type | Required | Description |
| AssetId | String | True | The unique identifier for the asset you wish to download, used to locate the asset in the system or database. |
| LocalPath | String | False | The absolute file path where the asset will be saved on the local system. This must be a fully qualified path, including the filename and extension. |
| Name | Type | Description |
| Success | Boolean | A boolean value indicating the success of the operation. A true value indicates the asset download completed successfully, while false indicates an error occurred. |
| Details | String | A detailed message offering more information about the operation's execution. This can provide context for success, partial success, or failure, useful for troubleshooting. |
| FileData | String | The file data in base64 encoding, returned when both the LocalPath and FileStream inputs are not provided. This allows the file to be transmitted in a text-based format suitable for embedding or storage. |
Creates a duplicate of an existing board, including its items, columns, and structure.
| Name | Type | Required | Description |
| BoardId | String | True | The unique identifier of the board being duplicated, used to reference the source board in the operation. |
| DuplicateType | String | True | Specifies the type of duplication being performed, which can determine the extent or method of the duplication (for example, full duplication, partial duplication).
使用できる値は次のとおりです。duplicate_board_with_structure, duplicate_board_with_pulses, duplicate_board_with_pulses_and_updates |
| BoardName | String | False | The name to be assigned to the new board being created during the duplication. If not provided, the system will automatically generate a name for the new board. |
| WorkspaceId | String | False | The identifier of the workspace where the duplicated board should be placed. If omitted, the new board will be placed in the same workspace as the original board. |
| FolderId | String | False | The identifier of the folder within the destination workspace for placing the new board. If not provided, the original board's folder is used as the default. |
| KeepSubscribers | Boolean | False | Indicates whether the subscribers of the original board should be copied to the new board. By default, this is set to false, meaning subscribers are not duplicated. |
| Name | Type | Description |
| Success | Boolean | A boolean value indicating whether the duplication operation was completed successfully. A value of true means the operation was successful, and false means it failed. |
| Details | String | A message that provides additional details about the result of the operation, which can be useful for debugging or understanding why a failure occurred. |
| BoardId | String | The unique identifier of the new board created as a result of the duplication operation, which can be used for further actions or queries. |
Duplicate a document.
| Name | Type | Required | Description |
| DocId | String | True | The document's unique identifier. |
| DuplicateType | String | False | The document's duplication types.
使用できる値は次のとおりです。duplicate_doc_with_content, duplicate_doc_with_content_and_updates |
| Name | Type | Description |
| Success | Boolean | Indicates whether or not the operation executed successfully. |
| Details | String | Any extra details on the operation's execution. |
| DocId | String | The document's unique identifier. |
Duplicates an existing group within a board.
| Name | Type | Required | Description |
| BoardId | String | True | The unique identifier of the board where the group will be added, used to target the specific board for the operation. |
| GroupId | String | True | The unique identifier of the group being modified or created, allowing the operation to reference a specific group within the board. |
| AddToTop | Boolean | False | A flag indicating whether the new group should be placed at the top of the board or list. If true, the group is added to the top; if false, it is added at the default position. |
| GroupTitle | String | False | The title or name of the group being created or modified, used for identification and display purposes within the board. |
| Name | Type | Description |
| Success | Boolean | A boolean flag indicating whether the operation was successful. True means the group was successfully added or modified; false indicates an error occurred. |
| Details | String | A message providing additional information on the operation's outcome, helpful for understanding errors or confirming successful execution. |
| GroupId | String | The unique identifier of the newly created or modified group, which can be used to reference the group in future operations. |
Duplicates an item within a board, including its associated data.
| Name | Type | Required | Description |
| BoardId | String | True | The unique identifier for the board containing the item. |
| WithUpdates | Boolean | False | A flag indicating whether the duplication should include any updates related to the item. Setting this flag ensures the item is copied along with its most recent changes. |
| ItemId | String | True | The unique identifier for the item being duplicated. This is used to identify and replicate the specific item in the database. |
| Name | Type | Description |
| Success | Boolean | A boolean value that indicates whether the duplication was successful. A value of true means the duplication was completed successfully, while false indicates an error occurred. |
| Details | String | A text message that provides additional context or error details about the duplication process, useful for troubleshooting or confirming the behavior of the duplication. |
| ItemId | String | The unique identifier of the item that was duplicated, returned to confirm the specific item that was successfully copied. |
Retrieve information about the connected account.
| Name | Type | Description |
| Success | Boolean | Indicates whether or not the operation executed successfully. |
| Details | String | Any extra details on the operation's execution. |
| Id | String | The account's unique identifier. |
| Slug | String | The account's slug. |
| Name | String | The account's name. |
| CountryCode | String | The account's country two-letter code in ISO3166 format |
| FirstDayOfTheWeek | String | The first day of the week for the account (sunday / monday) |
| ShowTimelineWeekends | Bool | Show weekends in timeline |
| Logo | String | The account's logo. |
| Tier | String | The account's tier. |
| PlanTier | String | The plan's tier. |
| PlanVersion | Int | The plan's version. |
| PlanPeriod | String | The plan's time period. |
| PlanMaxUsers | Int | The maximum users allowed in the plan. |
| ActiveMembersCount | Int | The number of active member users in the account |
| SignUpProductKind | String | The product the account signed up to first. |
Fetches the OAuth Access Token, which is used to authenticate and authorize API calls made to Monday.
| Name | Type | Required | Description |
| AuthMode | String | False | The type of authentication mode to use. The allowed values are APP, WEB.
使用できる値は次のとおりです。APP, WEB |
| Verifier | String | False | The verifier token returned by Monday after using the URL obtained with GetOAuthAuthorizationURL. Required for only the Web AuthMode. |
| Scope | String | False | The scope or permissions you are requesting. |
| CallbackUrl | String | False | The URL the user will be redirected to after authorizing your application. |
| State | String | False | This field indicates any state that may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to Monday authorization server and back. Uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery. |
| Name | Type | Description |
| OAuthAccessToken | String | The authentication token returned from Monday. |
| OAuthRefreshToken | String | A token that may be used to obtain a new access token. |
| ExpiresIn | String | The remaining lifetime for the access token in seconds. |
Retrieves the OAuth Authorization URL, allowing the client to direct the user's browser to the authorization server and initiate the OAuth process.
| Name | Type | Required | Description |
| CallbackUrl | String | False | The URL that Monday will return to after the user has authorized your app. |
| Scope | String | False | The scope or permissions you are requesting. |
| State | String | False | This field indicates any state that may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to Monday authorization server and back. Uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery. |
| Name | Type | Description |
| URL | String | The URL to be entered into a Web browser to obtain the verifier token and authorize the data provider with. |
Adds a 'like' to a specific update, indicating approval or acknowledgment.
| Name | Type | Required | Description |
| UpdateId | String | True | The unique identifier for the update operation, used to track and reference specific update actions being performed in the procedure. |
| Name | Type | Description |
| Success | Boolean | A flag indicating whether the update operation was successful. A value of true means the update was successfully applied, while false indicates that an error occurred during execution. |
| Details | String | A message providing additional context or error details regarding the update operation, offering insights into why the operation may have failed or succeeded. |
| UpdateId | String | The identifier associated with the update, returned to confirm the completion of the update process and to allow tracking of the changes made. |
Moves an item from its current board to a different board, transferring all associated data.
| Name | Type | Required | Description |
| BoardId | String | True | The unique identifier of the target board where items or groups will be moved or manipulated during the procedure. |
| GroupId | String | True | The unique identifier of the target group within the board to which an item will be moved or associated. |
| ItemId | String | True | The unique identifier of the item that is intended to be moved from one group or board to another. |
| ColumnsMapping | String | False | A mapping that defines how the columns in the original board correspond to the columns in the target board, ensuring data consistency during the operation. |
| SubitemsColumnsMapping | String | False | A mapping that defines how subitem columns in the original board correspond to the subitem columns in the target board, preserving the structure of subitems in the new board. |
| Name | Type | Description |
| Success | Boolean | A boolean flag indicating the success or failure of the operation. A value of true confirms the procedure executed successfully, while false indicates an error or failure. |
| Details | String | A message that provides additional context or information regarding the execution of the operation, such as errors or partial successes, to help with troubleshooting. |
| ItemId | String | The unique identifier of the item after the operation, confirming its final status or location after being moved or modified. |
Pins a specific update, keeping it at the top of the update list for better visibility.
| Name | Type | Required | Description |
| Id | String | True | The unique identifier for the update operation, used to reference the specific update being applied in the system. |
| ItemId | String | False | The unique identifier for the item being updated, allowing the procedure to target the specific item in the database. |
| Name | Type | Description |
| Success | Boolean | A boolean value indicating the success of the operation. True means the update was applied successfully, while false indicates a failure or error during execution. |
| Details | String | A string containing additional information about the execution of the operation, useful for understanding any issues or providing insight into the outcome. |
| Id | String | The unique identifier for the item after the update, confirming the item being affected and allowing any further interactions with it. |
| PinnedToTopItemIds | String | A comma-separated list of item IDs representing the items that are pinned to the top as a result of the update. This helps track which items have been prioritized in the user interface. |
Removes a mock app subscription for the current account, typically used for testing purposes.
| Name | Type | Required | Description |
| AppId | String | True | The unique identifier for the app whose mocked subscription is being removed. This is used to locate the app in the system to ensure the correct subscription is targeted for removal. |
| PartialSigningSecret | String | True | The last 10 characters of the app's signing secret. This partial secret is used for verification purposes to ensure the request is coming from a legitimate source. |
| Name | Type | Description |
| Success | Boolean | A flag indicating whether the operation was successful. A value of true means the subscription removal was completed without issues, while false suggests there was an error during the process. |
| Details | String | A message that provides additional information about the operation's execution, such as any encountered errors or steps that were skipped during the removal process. |
| PlanId | String | The identifier for the mocked plan associated with the app. This value links to the specific plan being referenced for testing or simulation purposes. |
Sets a mock app subscription for the current account, enabling testing scenarios.
| Name | Type | Required | Description |
| AppId | String | True | The unique identifier of the application for which the subscription is being simulated, used to associate the mock subscription with the correct app in the system. |
| PartialSigningSecret | String | True | The last 10 characters of the application's signing secret, used for verifying and authenticating the app during the subscription mock process. |
| PlanId | String | False | The unique identifier of the plan to be simulated in the mock subscription, ensuring the correct plan is applied to the subscription. |
| IsTrial | Boolean | False | A boolean flag indicating whether the subscription being mocked is a trial subscription, which may affect the pricing and renewal terms. |
| RenewalDate | Datetime | False | The date when the subscription will be renewed. This field is essential for determining the timing of the next billing cycle or trial expiration. |
| BillingPeriod | String | False | The frequency of billing for the subscription, either monthly or yearly, which dictates the payment schedule and the subscription's renewal cycle. |
| PricingVersion | Int | False | The version of the pricing structure being applied to the mock subscription, allowing flexibility in testing different pricing models. |
| MaxUnits | Int | False | Maximum number of units for the mocked plan. |
| Name | Type | Description |
| Success | Boolean | A flag indicating whether the subscription mock operation was completed successfully. A value of 'true' means the mock was successfully applied, and 'false' indicates an error or failure. |
| Details | String | Additional context or messages regarding the outcome of the mock subscription operation, useful for debugging or understanding why an operation might have failed. |
| PlanId | String | The plan ID that was assigned to the mocked subscription, reflecting the plan used in the simulated subscription setup. |
Unpins a previously pinned update, allowing it to return to its chronological position.
| Name | Type | Required | Description |
| Id | String | True | The unique identifier for the update operation, used to locate and apply changes to a specific update in the system. |
| ItemId | String | False | The unique identifier for the item being updated, ensuring that the operation targets the correct item in the database. |
| Name | Type | Description |
| Success | Boolean | A boolean flag indicating whether the update operation was successful. A value of true signifies that the update completed without errors, while false indicates a failure occurred. |
| Details | String | A detailed message providing further information about the update operation, including reasons for failure or any important notes related to its execution. |
| Id | String | The unique identifier assigned to the item after the update, confirming the specific item that was affected by the operation. |
| PinnedToTopItemIds | String | A comma-separated list of item IDs that have been pinned to the top after the update, allowing easy reference to the items prioritized for visibility. |
Update a board's position, workspace, or product.
| Name | Type | Required | Description |
| BoardId | String | True | The unique identifier of the board. |
| WorkspaceId | String | False | The board's workspace unique identifier (null for main workspace). |
| AccountProductId | String | False | The board's updated account product ID. |
| FolderId | String | False | The board's updated folder ID. |
| PositionObjectId | String | False | The unique identifier of the reference object that the target board should be positioned relative to. |
| PositionObjectType | String | False | The type of the reference object. |
| PositionIsAfter | Boolean | False | Specifies where to position the target board relative to the reference object. |
| Name | Type | Description |
| Success | Boolean | Indicates whether or not the operation executed successfully. |
| Details | String | Any extra details on the operation's execution. |
| BoardId | String | The unique identifier of the board. |
In the AuditLog Data Model schema, the provider models activity logs that capture key user interactions, security events, and system changes within the Monday.com account as an easy-to-use SQL database. Live connectivity to these objects means that any changes to your Monday.com account are immediately reflected in the provider.
The ビュー section, which lists read-only SQL tables, model data that is read-only and cannot be updated.
Views include:
| View | Description |
| AuditLogs | Retrieves the audit log events for a specific board, providing a detailed history of actions performed. |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
| Name | Description |
| AuditLogs | Retrieves the audit log events for a specific board, providing a detailed history of actions performed. |
Retrieves the audit log events for a specific board, providing a detailed history of actions performed.
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 date and time when the event occurred, recorded in a standard datetime format. | |
| AccountId | String | The unique identifier of the account that initiated the event, used to track account-level activity. | |
| UserId | Int | The unique identifier of the user who initiated the event, enabling user-specific auditing. | |
| Event | String | The specific action or operation that was performed, such as 'Login', 'Update', or 'Delete'.
使用できる値は次のとおりです。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-workspace, workspace-change-name, create-team, delete-team, approve-request-to-join-team, decline-request-to-join-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, account-role-permission-changed, workspace-role-permission-changed | |
| Slug | String | A human-readable identifier for the event, often used for categorization or reference. | |
| IpAddress | String | The IP address from which the event was initiated, useful for tracking geographic location or security purposes. | |
| UserAgent | String | The user agent string of the client initiating the event, providing details about the browser or application used. | |
| ClientName | String | The name of the software client used to initiate the event, such as 'Chrome', 'Postman', or 'CustomApp'. | |
| ClientVersion | String | The version number of the software client, used to identify the specific release or build of the application. | |
| OsName | String | The name of the operating system on the client device, such as 'Windows', 'macOS', or 'Linux'. | |
| OsVersion | String | The version number of the operating system running on the client device, such as 'Windows 10' or 'Ubuntu 22.04'. | |
| DeviceName | String | The name of the device from which the event originated, such as 'John's Laptop' or 'Workstation01'. | |
| DeviceType | String | The type of device used, such as 'Desktop', 'Laptop', 'Tablet', or 'Smartphone'. | |
| ActivityMetadata | String | Additional metadata or contextual information related to the event, providing further details about the activity. |
In the Workspace Data Model schema, the provider models the workspace-related data for managing projects as an easy-to-use SQL database. Live connectivity to these objects means that any changes to your Monday.com account are immediately reflected in the provider.
The テーブル section, which details standard SQL tables, contain the tables that you may have access to in your Monday account. These tables can be modified.
Tables include:
| Table | Description |
| Board | Represents a workspace board containing items, columns, and other related data used for task management. |
| BoardSubitems | Represents a subitems board, storing nested items related to a primary board's items for more detailed task tracking. |
ストアドプロシージャ are actions that are invoked via SQL queries. They perform tasks beyond standard CRUD operations, including uploading files, creating columns in a board, and duplicating an item in a board.
Sync App はMonday のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
| Name | Description |
| Board | Represents a workspace board containing items, columns, and other related data used for task management. |
| BoardSubitems | Represents a subitems board, storing nested items related to a primary board's items for more detailed task tracking. |
Represents a workspace board containing items, columns, and other related data used for task management.
Note that multiple filters are supported server-side (when they are all connected solely by AND logical operators or solely by 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
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')
INSERT INTO Board (Item, RelativeTo, PositionRelativeMethod) VALUES ('new', '7161109809', 'before_at')
The following inputs can be used in UPDATE statements:
CreateLabelsIfMissing, BoardId, BoardRelationLinkedItemIds, ItemName, 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, and Week).
UPDATE Board SET GroupId = 'new_group' WHERE ItemId = '5562458608'
UPDATE Board SET State = 'archived' WHERE ItemId = '5562458608'
UPDATE Board SET ItemName = 'Test' WHERE ItemId = '5561890829'
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'
You can delete items by specifying the ItemId.
DELETE FROM Board WHERE ItemId = '5561890829'
| Name | Type | ReadOnly | References | Description |
| ItemId [KEY] | String | False |
The unique identifier for each item in the system, used to reference and distinguish items across the database. | |
| CreatorId | String | False |
The unique identifier of the user who created the item, allowing tracking of item origin. | |
| CreatedAt | Datetime | False |
The date and time when the item was created in the system, useful for audit and tracking item age. | |
| UpdatedAt | Datetime | False |
The date and time of the most recent update made to the item, enabling tracking of changes over time. | |
| State | String | False |
The current state of the item, indicating whether it is active, archived, deleted, or in any other defined state. | |
| RelativeLink | String | False |
The relative URL path pointing to the item's location within the system or application. | |
| ItemEmail | String | False |
The email address associated with the item, typically used for notifications or communication. | |
| Url | String | False |
The full URL link pointing to the item or related resource, allowing direct access to the item online. | |
| AssetsIds | String | False |
A comma-separated list of unique identifiers for the assets or files associated with the item, facilitating easy referencing. | |
| GroupId | String | False |
The identifier of the group to which this item belongs, used to categorize and manage items in groups. | |
| GroupTitle | String | False |
The title or name of the group containing the item, offering contextual categorization. | |
| Item | String | False |
The name of the item, typically used as a label or title within the system. | |
| BoardRelationDisplayValue | String | False |
A string representing the names of linked items, separated by commas, to visualize their relationship. | |
| BoardRelationLinkedItemIds | String | False |
A comma-separated list of item IDs that are linked to the current item, allowing for reference to related data. | |
| ButtonLabel | String | False |
The label or text displayed on the button associated with the item, providing a user-friendly description of the button's function. | |
| ButtonColor | String | False |
The color of the button in hexadecimal format, used to define the button's visual style. | |
| ButtonValue | String | False |
The value associated with the button, typically represented in JSON format for structured data processing. | |
| Check | Bool | False |
The boolean value indicating whether a condition is true (checked) or false (unchecked), commonly used in forms. | |
| ColorPickerColor | String | False |
The selected color in hexadecimal format, used to specify color preferences in the item. | |
| ColorPickerValue | String | False |
The color value in JSON format, representing the full color configuration for the item. | |
| CountryCode | String | False |
The two-letter ISO code representing the country of the item or associated data. | |
| CountryName | String | False |
The full name of the country associated with the item, providing clarity for localization. | |
| DateIcon | String | False |
A string representing the icon selected for the date, used for visual representation of date fields. | |
| Date | Date | False |
The date value for the item, typically used to represent important events or milestones. | |
| Datetime | Datetime | False |
The datetime value associated with the item, used for tracking both date and time of events. | |
| DependencyDisplayValue | String | False |
A string listing the names of items upon which this task depends, enabling visual representation of task dependencies. | |
| DependencyLinkedItemsIds | String | False |
A list of item IDs representing the tasks or items that this task depends on, ensuring task scheduling accuracy. | |
| DocFileId | String | False |
The unique identifier for the document file associated with the item, used for managing document-related data. | |
| DocFileCreatorId | String | False |
The ID of the user who created the document file, useful for tracking document ownership and history. | |
| DocFileObjectId | String | False |
The identifier of the object or board related to the document file, linking the file to its contextual data. | |
| DocFileUrl | String | False |
The URL where the document file can be accessed or downloaded, providing direct access to the document. | |
| DocFileDocId | String | False |
The unique document identifier associated with the file, used for cross-referencing within document management systems. | |
| DropdownText | String | False |
The text value selected from a dropdown list, representing the user's choice in a user-friendly format. | |
| DropdownValue | String | False |
The value associated with the dropdown selection, represented in JSON format for structured data. | |
| String | False |
The email address associated with the column, typically used for notifications or communications related to the item. | ||
| EmailLabel | String | False |
The label or description of the email field, which may be the same as the email address if no label was entered. | |
| FileText | String | False |
The text value of the file column, used for storing textual content related to the file. | |
| FileValue | String | False |
The value of the file column in JSON format, allowing structured representation of file data. | |
| Hour | Time | False |
The time value associated with the item, representing a specific hour or time in a day. | |
| IntegrationIssueId | String | False |
The unique identifier for the integration issue, used for tracking issues in third-party integrations. | |
| IntegrationEntityId | String | False |
The unique identifier for the entity involved in the integration, allowing for efficient tracking and management. | |
| IntegrationIssueApiUrl | String | False |
The API URL where details about the integration issue can be accessed, facilitating debugging and resolution. | |
| IntegrationValue | String | False |
The value in JSON format representing the data or configuration related to the integration issue. | |
| LastUpdated | String | False |
The identifier of the user who last updated the item, allowing for tracking of who made the most recent changes. | |
| LinkUrl | String | False |
The URL link associated with the item, used to direct users to external resources or related items. | |
| LinkUrlText | String | False |
The display text for the link, providing context or description for users about the link's destination. | |
| LocationLat | Double | False |
The latitude coordinate of the item's location, used for mapping and geospatial purposes. | |
| LocationLng | Double | False |
The longitude coordinate of the item's location, used in conjunction with latitude for accurate geolocation. | |
| LocationPlaceId | String | False |
The place ID associated with the item's location, used for precise location identification in mapping systems. | |
| LocationAddress | String | False |
The full address of the item's location, providing complete details for geolocation purposes. | |
| LocationCity | String | False |
The city in which the item is located, used to specify its geographic location. | |
| LocationCityShort | String | False |
A shorthand version of the city's name, typically used for space-saving purposes. | |
| LocationCountry | String | False |
The country where the item is located, providing regional context for the item. | |
| LocationCountryShort | String | False |
A shortened version of the country's name, typically using its two-letter ISO code. | |
| LocationStreet | String | False |
The street address of the item's location, giving a precise physical location. | |
| LocationStreetNumber | String | False |
The street number of the building, giving additional detail to the street address. | |
| LocationStreetNumberShort | String | False |
A shorthand version of the building number, typically used in forms with limited space. | |
| LocationStreetShort | String | False |
A shortened version of the street name, used when space is limited or for abbreviated addresses. | |
| LongText | String | False |
A field for storing longer text, typically used for descriptions, notes, or additional information. | |
| MirrorDisplayValue | String | False |
The display value for items mirrored from other sources, typically representing the original data. | |
| MirroredItems | String | False |
A list of items that are mirrored, representing items whose data is replicated across different locations. | |
| Numbers | Double | False |
A numeric value representing any relevant quantity or measurement associated with the item. | |
| PeopleText | String | False |
The text value for the people column, used for storing names or descriptions of people related to the item. | |
| PeopleValue | String | False |
The value of the people column in JSON format, representing structured data about people. | |
| PhoneCountryShortName | String | False |
The ISO-2 country code representing the country of the phone number. | |
| Phone | String | False |
The phone number associated with the item, used for contact purposes. | |
| Rating | Int | False |
An integer representing the rating assigned to the item, typically used in review or feedback systems. | |
| StatusIndex | Int | False |
The index number of the status in the board, allowing for sorting and managing item statuses. | |
| StatusIsDone | Bool | False |
A boolean indicating whether the status of the item is marked as complete or not. | |
| StatusLabel | String | False |
The label or name of the status, providing a user-friendly identifier for the item's state. | |
| StatusUpdateId | String | False |
The unique identifier for the status update, allowing for tracking of changes to the item's status. | |
| StatusLabelStyleColor | String | False |
The hexadecimal color value representing the style of the status label, used to define the label's visual color. | |
| StatusLabelStyleBorder | String | False |
The hexadecimal color value representing the style of the status label's border, used for visual distinction. | |
| TagsText | String | False |
The textual representation of the tags associated with the item, providing an easy-to-read list of tags. | |
| TagsIds | String | False |
A list of tag IDs associated with the item, allowing for filtering and categorization based on tags. | |
| Text | String | False |
The text value of the item, typically used for storing descriptions, titles, or other relevant textual data. | |
| TimeTrackingRunning | Bool | False |
A boolean value indicating whether the time tracker associated with the item is currently running. | |
| TimeTrackingStartedAt | Datetime | False |
The timestamp of when the time tracking was started, providing a reference for when the activity began. | |
| TimeTrackingDuration | Int | False |
The total duration in seconds for which the time tracker has been running. | |
| TimelineFrom | Date | False |
The start date for the timeline, used to specify when the project or task begins. | |
| TimelineTo | Date | False |
The end date for the timeline, marking the completion or due date for the project or task. | |
| TimelineVisualizationType | String | False |
The type of visualization to use for the timeline, defining how the timeline data is presented to the user. | |
| VoteCount | Int | False |
The total number of votes cast for the item, used in voting or polling scenarios. | |
| VoterIds | String | False |
A list of user IDs who have voted on the item, used to track voter participation. | |
| WeekStartDate | Date | False |
The start date for the week, typically used for scheduling or time tracking purposes. | |
| WeekEndDate | Date | False |
The end date for the week, marking the conclusion of the weekly period. | |
| WorldClock | String | False |
The timezone or world clock setting used to display the item's time in the correct time zone. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| RelativeTo | String |
The item to which the current item is relative, used for positioning items next to each other in a layout. |
| PositionRelativeMethod | String |
The method used to determine the item's position relative to another item, either before or after it. |
| CreateLabelsIfMissing | Bool |
A pseudocolumn that indicates whether new labels for status or dropdown fields should be created if missing, requiring board structure modification permissions. |
Represents a subitems board, storing nested items related to a primary board's items for more detailed task tracking.
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
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')
The following inputs can be used in UPDATE statements:
CreateLabelsIfMissing, BoardId, BoardRelationLinkedItemIds, ItemName, 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'
You can delete entries by specifying the ItemId.
DELETE FROM BoardSubItems WHERE ItemId = '5561890829'
| Name | Type | ReadOnly | References | Description |
| ItemId [KEY] | String | False |
The unique identifier for each item in the system, used for referencing and querying specific items. | |
| ParentItemId | String | False |
The unique identifier of the parent item, indicating the hierarchical relationship between items. | |
| CreatorId | String | False |
The unique identifier of the user who created the item, helpful for tracking ownership. | |
| CreatedAt | Datetime | False |
The timestamp representing when the item was created in the system. | |
| UpdatedAt | Datetime | False |
The timestamp representing the last time the item was updated, useful for tracking changes. | |
| State | String | False |
Represents the current status of the item, such as 'all', 'active', 'archived', or 'deleted'. | |
| RelativeLink | String | False |
The relative URL or path to the item, used for navigation or linking within the system. | |
| ItemEmail | String | False |
The email address associated with the item, if applicable, typically used for notifications or communications. | |
| Url | String | False |
The full URL link to the item, providing access to the item’s page or resource. | |
| AssetsIds | String | False |
A comma-separated list of unique identifiers for the assets or files associated with the item. | |
| GroupId | String | False |
The identifier of the group to which the item belongs, used to organize and categorize items. | |
| GroupTitle | String | False |
The title or name of the group that contains this item, providing context for grouping and organization. | |
| Subitem | String | False |
The name or description of the subitem, typically used in hierarchical or dependent structures. | |
| OwnerText | String | False |
The textual value of the column, providing a human-readable form of the data stored in that column. | |
| OwnerValue | String | False |
The value of the column represented in JSON format, capturing complex data in a structured format. | |
| StatusIndex | Int | False |
The index position of the current status in the board, helping to identify its order in a list of statuses. | |
| StatusIsDone | Bool | False |
Indicates whether the item is marked as 'done' in its current status, used for task tracking. | |
| StatusLabel | String | False |
The label or name assigned to the status, which is visible to users to indicate the item’s progress. | |
| StatusUpdateId | String | False |
The unique identifier for any updates linked to the item’s current status, useful for tracking changes. | |
| StatusLabelStyleColor | String | False |
The color style applied to the status label, represented as a hex value to visually indicate the status. | |
| StatusLabelStyleBorder | String | False |
The border color style applied to the status label, represented as a hex value, enhancing visual distinction. | |
| DateIcon | String | False |
The icon associated with the date field, represented as a string, used for visual reference or selection. | |
| Date | Date | False |
The date value stored in the column, used to track specific dates associated with the item. | |
| Datetime | Datetime | False |
The datetime value stored in the column, capturing both the date and time of an event or action. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| CreateLabelsIfMissing | Bool |
A pseudocolumn that triggers the creation of missing status or dropdown labels, requiring proper permissions to modify the board structure. |
ストアドプロシージャはファンクションライクなインターフェースで、Monday の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずSync App の機能を拡張します。
ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにMonday から関連するレスポンスデータを返します。
| Name | Description |
| AddContentToDocFromMarkdown | Adds markdown content to an existing document by converting it into document blocks. |
| AddFileToColumn | Attaches a file to a specific column value in a board, enhancing item detail management. |
| AddFileToUpdate | Uploads and associates a file with a specific update in Monday. |
| BatchExtendTrialPeriod | Extends the trial period of an application for multiple selected accounts simultaneously. |
| ChangeColumnMetadata | Change a column's properties. |
| ClearItemUpdates | Clears updates associated with a specific item on a board. |
| CreateColumn | Create a new column in a board. |
| CreateDocBlock | Creates a new content block within a document in Monday. |
| CreateDocBoard | Creates a new document within a board. |
| CreateNotification | Sends a new notification to users, detailing specific events or updates. |
| DeleteColumn | Delete a column. |
| DuplicateBoard | Creates a duplicate of an existing board, including its items, columns, and structure. |
| DuplicateDoc | Duplicate a document. |
| DuplicateGroup | Duplicates an existing group within a board. |
| DuplicateItem | Duplicates an item within a board, including its associated data. |
| GetAccount | Retrieve information about the connected account. |
| LikeUpdate | Adds a 'like' to a specific update, indicating approval or acknowledgment. |
| MoveItemToBoard | Moves an item from its current board to a different board, transferring all associated data. |
| PinUpdate | Pins a specific update, keeping it at the top of the update list for better visibility. |
| RemoveMockAppSubscription | Removes a mock app subscription for the current account, typically used for testing purposes. |
| SetMockAppSubscription | Sets a mock app subscription for the current account, enabling testing scenarios. |
| UnpinUpdate | Unpins a previously pinned update, allowing it to return to its chronological position. |
| UpdateBoardHierarchy | Update a board's position, workspace, or product. |
Adds markdown content to an existing document by converting it into document blocks.
| Name | Type | Required | Description |
| DocId | String | True | The unique identifier of the doc to add the content to. |
| AfterBlockId | String | False | The unique identifier of the block to insert the markdown content after. |
| Markdown | String | True | The markdown content to add and convert. |
| Name | Type | Description |
| Success | Boolean | Indicates whether or not the operation executed successfully. |
| Details | String | Any extra details on the operation's execution. |
| BlockId | String | The document block's unique identifier. |
Attaches a file to a specific column value in a board, enhancing item detail management.
| Name | Type | Required | Description |
| ItemId | String | True | Specifies the unique identifier of the item to which the file will be attached. This should correspond to an existing item in the database. |
| ColumnId | String | True | Specifies the unique identifier of the column where the file will be added. The column must exist and be associated with the specified item. |
| FileName | String | False | Specifies the name of the file being uploaded. This is required when the file's content is provided via the Content input parameter. |
| LocalPath | String | False | Specifies the local file path of the file to be uploaded. Use this when the file content is being uploaded from a local source. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the file was successfully uploaded and attached to the specified column. |
| Details | String | Provides additional information about the execution of the operation, such as warnings or errors encountered. |
| AssetId | String | Returns the unique identifier (Asset ID) assigned to the uploaded file for future reference. |
Uploads and associates a file with a specific update in Monday.
| Name | Type | Required | Description |
| UpdateId | String | True | Specifies the unique identifier (ID) of the update to which the file should be added. |
| FileName | String | False | Specifies the name of the file being added. This is required if 'Content' is provided. |
| LocalPath | String | False | Specifies the local file path of the file to be uploaded. This is used when 'Content' is not provided. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the file was successfully added to the update. |
| Details | String | Provides additional details about the execution of the operation, such as errors or warnings. |
| AssetId | String | Returns the unique identifier (ID) of the uploaded file for reference. |
Extends the trial period of an application for multiple selected accounts simultaneously.
| Name | Type | Required | Description |
| AccountSlugs | String | True | A comma-separated list of account slugs (unique identifiers for accounts). Maximum allowed: 5. |
| AppId | String | True | The unique identifier (ID) of the application associated with the trial period extension. |
| PlanId | String | True | The unique identifier (ID) of the payment plan linked to the accounts for trial extension. |
| DurationInDays | Integer | True | The number of days by which the trial period should be extended. Maximum allowable extension: 365 days. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the batch operation to extend the trial period was successful. |
| Reason | String | Provides a detailed reason for any error encountered during the batch operation. |
Change a column's properties.
| Name | Type | Required | Description |
| BoardId | String | True | The board's unique identifier. |
| Id | String | True | The column's unique identifier. |
| ColumnProperty | String | True | The property name of the column to be changed (title / description).
使用できる値は次のとおりです。title, description |
| Value | String | False | The new description of the column. |
| Name | Type | Description |
| Success | Boolean | Indicates whether or not the operation executed successfully. |
| Details | String | Any extra details on the operation's execution. |
| Id | String | The column's unique identifier. |
Clears updates associated with a specific item on a board.
| Name | Type | Required | Description |
| ItemId | String | True | Specifies the unique identifier (ID) of the item for which updates are to be cleared. |
| Name | Type | Description |
| Success | Boolean | Returns a boolean indicating whether the operation to clear updates for the specified item was successful. |
| Details | String | Provides additional details or messages about the execution of the operation, such as errors or warnings. |
| ItemId | String | Returns the unique identifier (ID) of the item for which updates were cleared. |
Create a new column in a board.
| Name | Type | Required | Description |
| BoardId | String | True | The board's unique identifier. |
| Title | String | True | The new column's title. |
| Description | String | False | The new column's description. |
| ColumnType | String | True | The type of column to create. |
| Defaults | String | False | The new column's defaults. |
| Id | String | False | The column's user-specified unique identifier. |
| AfterColumnId | String | False | The column's unique identifier after which the new column will be inserted. |
| Name | Type | Description |
| Success | Boolean | Indicates whether or not the operation executed successfully. |
| Details | String | Any extra details on the operation's execution. |
| Id | String | The column's unique identifier. |
Creates a new content block within a document in Monday.
| Name | Type | Required | Description |
| DocId | String | True | Specifies the unique identifier (ID) of the document where the block will be created. |
| AfterBlockId | String | False | Indicates the block ID after which the new block should be inserted. If not provided, the new block is inserted at the beginning of the document. |
| ParentBlockId | String | False | Specifies the ID of the parent block under which the new block will be appended. Used for hierarchical block structures. |
| Type | String | True | Defines the content type of the block, such as text, image, or table.
使用できる値は次のとおりです。board, bulleted_list, check_list, code, divider, image, large_title, layout, medium_title, normal_text, notice_box, numbered_list, quote, small_title, table, video, widget, page_break |
| Content | String | True | Specifies the content to include in the new block, such as text or other media. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the block creation operation was successfully completed. |
| Details | String | Provides additional details about the execution of the block creation operation, including error messages if applicable. |
| DocumentBlockId | String | Returns the unique identifier (ID) of the newly created document block. |
Creates a new document within a board.
| Name | Type | Required | Description |
| ItemId | String | True | The unique identifier for the item being processed, used to reference the specific item in the database for the operation. |
| ColumnId | String | True | The unique identifier for the column being manipulated, allowing the procedure to target a specific column within the table or schema. |
| Name | Type | Description |
| Success | Boolean | A flag indicating whether the operation was successful. A value of true means the operation completed without errors, while false indicates failure. |
| Details | String | A message providing additional information about the operation's execution, useful for debugging or understanding partial successes or failures. |
| DocumentId | String | The unique identifier assigned to the document created or updated by the operation, linking it to the document management system or database. |
Sends a new notification to users, detailing specific events or updates.
| Name | Type | Required | Description |
| Text | String | True | The content of the notification message, providing the information or alert to be sent to the target. |
| UserId | String | True | The unique identifier for the user initiating or receiving the notification, typically used to reference the user's account in the system. |
| TargetId | String | True | The unique identifier for the target object of the notification, which can be a project, post, or another relevant entity. |
| TargetType | String | True | The type of the target object (for example, Project or Post) that the notification pertains to, used to determine the context of the notification.
使用できる値は次のとおりです。Project, Post |
| Name | Type | Description |
| Success | Boolean | A flag indicating the outcome of the operation. A true value signifies that the notification was successfully sent or processed, while false indicates failure. |
| Details | String | Additional information about the operation, such as an error message or context, useful for troubleshooting or understanding the result of the operation. |
| NotificationId | String | The unique identifier for the notification that was created or processed, which can be used to reference or track the notification in the system. |
Delete a column.
| Name | Type | Required | Description |
| BoardId | String | True | The board's unique identifier. |
| Id | String | True | The column's unique identifier. |
| Name | Type | Description |
| Success | Boolean | Indicates whether or not the operation executed successfully. |
| Details | String | Any extra details on the operation's execution. |
| Id | String | The column's unique identifier. |
Downloads a file uploaded to Monday.com by specifying the corresponding asset ID.
| Name | Type | Required | Description |
| AssetId | String | True | The unique identifier for the asset you wish to download, used to locate the asset in the system or database. |
| LocalPath | String | False | The absolute file path where the asset will be saved on the local system. This must be a fully qualified path, including the filename and extension. |
| Name | Type | Description |
| Success | Boolean | A boolean value indicating the success of the operation. A true value indicates the asset download completed successfully, while false indicates an error occurred. |
| Details | String | A detailed message offering more information about the operation's execution. This can provide context for success, partial success, or failure, useful for troubleshooting. |
| FileData | String | The file data in base64 encoding, returned when both the LocalPath and FileStream inputs are not provided. This allows the file to be transmitted in a text-based format suitable for embedding or storage. |
Creates a duplicate of an existing board, including its items, columns, and structure.
| Name | Type | Required | Description |
| BoardId | String | True | The unique identifier of the board being duplicated, used to reference the source board in the operation. |
| DuplicateType | String | True | Specifies the type of duplication being performed, which can determine the extent or method of the duplication (for example, full duplication, partial duplication).
使用できる値は次のとおりです。duplicate_board_with_structure, duplicate_board_with_pulses, duplicate_board_with_pulses_and_updates |
| BoardName | String | False | The name to be assigned to the new board being created during the duplication. If not provided, the system will automatically generate a name for the new board. |
| WorkspaceId | String | False | The identifier of the workspace where the duplicated board should be placed. If omitted, the new board will be placed in the same workspace as the original board. |
| FolderId | String | False | The identifier of the folder within the destination workspace for placing the new board. If not provided, the original board's folder is used as the default. |
| KeepSubscribers | Boolean | False | Indicates whether the subscribers of the original board should be copied to the new board. By default, this is set to false, meaning subscribers are not duplicated. |
| Name | Type | Description |
| Success | Boolean | A boolean value indicating whether the duplication operation was completed successfully. A value of true means the operation was successful, and false means it failed. |
| Details | String | A message that provides additional details about the result of the operation, which can be useful for debugging or understanding why a failure occurred. |
| BoardId | String | The unique identifier of the new board created as a result of the duplication operation, which can be used for further actions or queries. |
Duplicate a document.
| Name | Type | Required | Description |
| DocId | String | True | The document's unique identifier. |
| DuplicateType | String | False | The document's duplication types.
使用できる値は次のとおりです。duplicate_doc_with_content, duplicate_doc_with_content_and_updates |
| Name | Type | Description |
| Success | Boolean | Indicates whether or not the operation executed successfully. |
| Details | String | Any extra details on the operation's execution. |
| DocId | String | The document's unique identifier. |
Duplicates an existing group within a board.
| Name | Type | Required | Description |
| BoardId | String | True | The unique identifier of the board where the group will be added, used to target the specific board for the operation. |
| GroupId | String | True | The unique identifier of the group being modified or created, allowing the operation to reference a specific group within the board. |
| AddToTop | Boolean | False | A flag indicating whether the new group should be placed at the top of the board or list. If true, the group is added to the top; if false, it is added at the default position. |
| GroupTitle | String | False | The title or name of the group being created or modified, used for identification and display purposes within the board. |
| Name | Type | Description |
| Success | Boolean | A boolean flag indicating whether the operation was successful. True means the group was successfully added or modified; false indicates an error occurred. |
| Details | String | A message providing additional information on the operation's outcome, helpful for understanding errors or confirming successful execution. |
| GroupId | String | The unique identifier of the newly created or modified group, which can be used to reference the group in future operations. |
Duplicates an item within a board, including its associated data.
| Name | Type | Required | Description |
| BoardId | String | True | The unique identifier for the board containing the item. |
| WithUpdates | Boolean | False | A flag indicating whether the duplication should include any updates related to the item. Setting this flag ensures the item is copied along with its most recent changes. |
| ItemId | String | True | The unique identifier for the item being duplicated. This is used to identify and replicate the specific item in the database. |
| Name | Type | Description |
| Success | Boolean | A boolean value that indicates whether the duplication was successful. A value of true means the duplication was completed successfully, while false indicates an error occurred. |
| Details | String | A text message that provides additional context or error details about the duplication process, useful for troubleshooting or confirming the behavior of the duplication. |
| ItemId | String | The unique identifier of the item that was duplicated, returned to confirm the specific item that was successfully copied. |
Retrieve information about the connected account.
| Name | Type | Description |
| Success | Boolean | Indicates whether or not the operation executed successfully. |
| Details | String | Any extra details on the operation's execution. |
| Id | String | The account's unique identifier. |
| Slug | String | The account's slug. |
| Name | String | The account's name. |
| CountryCode | String | The account's country two-letter code in ISO3166 format |
| FirstDayOfTheWeek | String | The first day of the week for the account (sunday / monday) |
| ShowTimelineWeekends | Bool | Show weekends in timeline |
| Logo | String | The account's logo. |
| Tier | String | The account's tier. |
| PlanTier | String | The plan's tier. |
| PlanVersion | Int | The plan's version. |
| PlanPeriod | String | The plan's time period. |
| PlanMaxUsers | Int | The maximum users allowed in the plan. |
| ActiveMembersCount | Int | The number of active member users in the account |
| SignUpProductKind | String | The product the account signed up to first. |
Fetches the OAuth Access Token, which is used to authenticate and authorize API calls made to Monday.
| Name | Type | Required | Description |
| AuthMode | String | False | The type of authentication mode to use. The allowed values are APP, WEB.
使用できる値は次のとおりです。APP, WEB |
| Verifier | String | False | The verifier token returned by Monday after using the URL obtained with GetOAuthAuthorizationURL. Required for only the Web AuthMode. |
| Scope | String | False | The scope or permissions you are requesting. |
| CallbackUrl | String | False | The URL the user will be redirected to after authorizing your application. |
| State | String | False | This field indicates any state that may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to Monday authorization server and back. Uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery. |
| Name | Type | Description |
| OAuthAccessToken | String | The authentication token returned from Monday. |
| OAuthRefreshToken | String | A token that may be used to obtain a new access token. |
| ExpiresIn | String | The remaining lifetime for the access token in seconds. |
Retrieves the OAuth Authorization URL, allowing the client to direct the user's browser to the authorization server and initiate the OAuth process.
| Name | Type | Required | Description |
| CallbackUrl | String | False | The URL that Monday will return to after the user has authorized your app. |
| Scope | String | False | The scope or permissions you are requesting. |
| State | String | False | This field indicates any state that may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to Monday authorization server and back. Uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery. |
| Name | Type | Description |
| URL | String | The URL to be entered into a Web browser to obtain the verifier token and authorize the data provider with. |
Adds a 'like' to a specific update, indicating approval or acknowledgment.
| Name | Type | Required | Description |
| UpdateId | String | True | The unique identifier for the update operation, used to track and reference specific update actions being performed in the procedure. |
| Name | Type | Description |
| Success | Boolean | A flag indicating whether the update operation was successful. A value of true means the update was successfully applied, while false indicates that an error occurred during execution. |
| Details | String | A message providing additional context or error details regarding the update operation, offering insights into why the operation may have failed or succeeded. |
| UpdateId | String | The identifier associated with the update, returned to confirm the completion of the update process and to allow tracking of the changes made. |
Moves an item from its current board to a different board, transferring all associated data.
| Name | Type | Required | Description |
| BoardId | String | True | The unique identifier of the target board where items or groups will be moved or manipulated during the procedure. |
| GroupId | String | True | The unique identifier of the target group within the board to which an item will be moved or associated. |
| ItemId | String | True | The unique identifier of the item that is intended to be moved from one group or board to another. |
| ColumnsMapping | String | False | A mapping that defines how the columns in the original board correspond to the columns in the target board, ensuring data consistency during the operation. |
| SubitemsColumnsMapping | String | False | A mapping that defines how subitem columns in the original board correspond to the subitem columns in the target board, preserving the structure of subitems in the new board. |
| Name | Type | Description |
| Success | Boolean | A boolean flag indicating the success or failure of the operation. A value of true confirms the procedure executed successfully, while false indicates an error or failure. |
| Details | String | A message that provides additional context or information regarding the execution of the operation, such as errors or partial successes, to help with troubleshooting. |
| ItemId | String | The unique identifier of the item after the operation, confirming its final status or location after being moved or modified. |
Pins a specific update, keeping it at the top of the update list for better visibility.
| Name | Type | Required | Description |
| Id | String | True | The unique identifier for the update operation, used to reference the specific update being applied in the system. |
| ItemId | String | False | The unique identifier for the item being updated, allowing the procedure to target the specific item in the database. |
| Name | Type | Description |
| Success | Boolean | A boolean value indicating the success of the operation. True means the update was applied successfully, while false indicates a failure or error during execution. |
| Details | String | A string containing additional information about the execution of the operation, useful for understanding any issues or providing insight into the outcome. |
| Id | String | The unique identifier for the item after the update, confirming the item being affected and allowing any further interactions with it. |
| PinnedToTopItemIds | String | A comma-separated list of item IDs representing the items that are pinned to the top as a result of the update. This helps track which items have been prioritized in the user interface. |
Removes a mock app subscription for the current account, typically used for testing purposes.
| Name | Type | Required | Description |
| AppId | String | True | The unique identifier for the app whose mocked subscription is being removed. This is used to locate the app in the system to ensure the correct subscription is targeted for removal. |
| PartialSigningSecret | String | True | The last 10 characters of the app's signing secret. This partial secret is used for verification purposes to ensure the request is coming from a legitimate source. |
| Name | Type | Description |
| Success | Boolean | A flag indicating whether the operation was successful. A value of true means the subscription removal was completed without issues, while false suggests there was an error during the process. |
| Details | String | A message that provides additional information about the operation's execution, such as any encountered errors or steps that were skipped during the removal process. |
| PlanId | String | The identifier for the mocked plan associated with the app. This value links to the specific plan being referenced for testing or simulation purposes. |
Sets a mock app subscription for the current account, enabling testing scenarios.
| Name | Type | Required | Description |
| AppId | String | True | The unique identifier of the application for which the subscription is being simulated, used to associate the mock subscription with the correct app in the system. |
| PartialSigningSecret | String | True | The last 10 characters of the application's signing secret, used for verifying and authenticating the app during the subscription mock process. |
| PlanId | String | False | The unique identifier of the plan to be simulated in the mock subscription, ensuring the correct plan is applied to the subscription. |
| IsTrial | Boolean | False | A boolean flag indicating whether the subscription being mocked is a trial subscription, which may affect the pricing and renewal terms. |
| RenewalDate | Datetime | False | The date when the subscription will be renewed. This field is essential for determining the timing of the next billing cycle or trial expiration. |
| BillingPeriod | String | False | The frequency of billing for the subscription, either monthly or yearly, which dictates the payment schedule and the subscription's renewal cycle. |
| PricingVersion | Int | False | The version of the pricing structure being applied to the mock subscription, allowing flexibility in testing different pricing models. |
| MaxUnits | Int | False | Maximum number of units for the mocked plan. |
| Name | Type | Description |
| Success | Boolean | A flag indicating whether the subscription mock operation was completed successfully. A value of 'true' means the mock was successfully applied, and 'false' indicates an error or failure. |
| Details | String | Additional context or messages regarding the outcome of the mock subscription operation, useful for debugging or understanding why an operation might have failed. |
| PlanId | String | The plan ID that was assigned to the mocked subscription, reflecting the plan used in the simulated subscription setup. |
Unpins a previously pinned update, allowing it to return to its chronological position.
| Name | Type | Required | Description |
| Id | String | True | The unique identifier for the update operation, used to locate and apply changes to a specific update in the system. |
| ItemId | String | False | The unique identifier for the item being updated, ensuring that the operation targets the correct item in the database. |
| Name | Type | Description |
| Success | Boolean | A boolean flag indicating whether the update operation was successful. A value of true signifies that the update completed without errors, while false indicates a failure occurred. |
| Details | String | A detailed message providing further information about the update operation, including reasons for failure or any important notes related to its execution. |
| Id | String | The unique identifier assigned to the item after the update, confirming the specific item that was affected by the operation. |
| PinnedToTopItemIds | String | A comma-separated list of item IDs that have been pinned to the top after the update, allowing easy reference to the items prioritized for visibility. |
Update a board's position, workspace, or product.
| Name | Type | Required | Description |
| BoardId | String | True | The unique identifier of the board. |
| WorkspaceId | String | False | The board's workspace unique identifier (null for main workspace). |
| AccountProductId | String | False | The board's updated account product ID. |
| FolderId | String | False | The board's updated folder ID. |
| PositionObjectId | String | False | The unique identifier of the reference object that the target board should be positioned relative to. |
| PositionObjectType | String | False | The type of the reference object. |
| PositionIsAfter | Boolean | False | Specifies where to position the target board relative to the reference object. |
| Name | Type | Description |
| Success | Boolean | Indicates whether or not the operation executed successfully. |
| Details | String | Any extra details on the operation's execution. |
| BoardId | String | The unique identifier of the board. |
| プロパティ | 説明 |
| Schema | Limits displayed tables to those in the specified schema. |
| AuthScheme | The type of authentication to use when connecting to Monday. |
| APIToken | An API token associated with your Monday account. |
| URL | Your Monday account URL. |
| Domain | This property is deprecated. Use the URL connection property instead. |
| プロパティ | 説明 |
| OAuthClientId | カスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。 |
| OAuthClientSecret | カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ) |
| Scope | データへの適切なアクセスを確実にするために、認証ユーザーのアプリケーションへのアクセス範囲を指定します。 カスタムOAuth アプリケーションが必要な場合は、通常、アプリケーションの作成時に指定します。 |
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
| プロパティ | 説明 |
| FirewallType | provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。 |
| FirewallServer | ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。 |
| FirewallPort | プロキシベースのファイアウォールで使用するTCP ポートを指定します。 |
| FirewallUser | プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。 |
| FirewallPassword | プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。 |
| プロパティ | 説明 |
| ProxyAutoDetect | provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。 |
| ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレスを指定します。 |
| ProxyPort | クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバーのTCP ポートを指定します。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名を提供します。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザーのパスワードを指定します。 |
| ProxySSLType | ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプを指定します。 |
| ProxyExceptions | ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリストを指定します。 |
| プロパティ | 説明 |
| LogModules | ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。 |
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。 |
| Views | レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。 |
| プロパティ | 説明 |
| IncludeCustomFields | Set this property to true to include custom fields in queries on applicable tables. |
| MaxPointsPerCall | Specifies the maximum points allowed by the provider for a single API call. |
| MaxRows | 集計やGROUP BY を含まないクエリで返される最大行数を指定します。 |
| Other | 特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。 |
| ServerFirstDayOfWeek | The first day of the week, as defined in your account settings. |
| ServerTimezone | The time zone of your Monday account. |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。 |
| UseDisplayColumnNames | Boolean determining if the column names should match display names or internal API names (IDs). |
| UseDisplaySchemaNames | Boolean determining if the schema names should match display names or internal API names (IDs). |
| UseDisplayTableNames | Boolean determining if the table names should match display names or internal API names (IDs). |
| UserDefinedViews | カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
| プロパティ | 説明 |
| Schema | Limits displayed tables to those in the specified schema. |
| AuthScheme | The type of authentication to use when connecting to Monday. |
| APIToken | An API token associated with your Monday account. |
| URL | Your Monday account URL. |
| Domain | This property is deprecated. Use the URL connection property instead. |
Limits displayed tables to those in the specified schema.
By default, the Sync App lists tables from the following schemas:
Set this connection property to one of the schemas listed above to only show the tables and views associated with the schema specified.
For example, if you set this property to "Main workspace", the Sync App only lists tables and views from the Main Workspace.
The type of authentication to use when connecting to Monday.
You can set this connection property to one of the following:
An API token associated with your Monday account.
This connection property is required when AuthScheme is set to Token.
The value you should set in this property varies depending on the API you want to access.
To retrieve data from the GraphQL API, set this connection property to the value of a personal API token associated with your Monday account.
Finding your API Token (Administration Menu)
If you are an admin user on your monday.com account, you are able to access your API tokens from the "Administration" tab with the following steps:
Finding your API Token (Developer Menu)
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:
If you want to access data from the AuditLog API, set this connection property to the value of a AuditLog API token.
Note: You must have an enterprise subscription with Monday to access the AuditLog API.
Finding your AuditLog API Token
Your Monday account URL.
This connection property is only required when the Schema is set to "AuditLog".
You can copy the URL of your Monday homepage after logging in.
The format of the URL is https://{accountName}.monday.com/
For example: https://cdata-software.monday.com/.
Note: Replaced by 'URL'.
This property is deprecated. Use the URL connection property instead.
Specifies the domain of your Monday account, required only for tables in the AuditLog schema.
Example: https://yourdomain.monday.com
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
| プロパティ | 説明 |
| OAuthClientId | カスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。 |
| OAuthClientSecret | カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ) |
| Scope | データへの適切なアクセスを確実にするために、認証ユーザーのアプリケーションへのアクセス範囲を指定します。 カスタムOAuth アプリケーションが必要な場合は、通常、アプリケーションの作成時に指定します。 |
カスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
このプロパティは2つのケースで必要となります:
(ドライバーが埋め込みOAuth 資格情報を提供する場合、この値はすでにSync App によって設定されており、手動で入力する必要がないことがあります。)
OAuthClientId は、認証付きの接続を構成する際に、OAuthClientSecret やOAuthSettingsLocation などの他のOAuth 関連プロパティと一緒に使用されるのが一般的です。
OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。 この値は、通常、ID プロバイダーのアプリケーション登録設定で確認できます。 Client ID、Application ID、Consumer Key などとラベル付けされた項目を探してください。
クライアントID は、クライアントシークレットのような機密情報とは見なされませんが、アプリケーションの識別情報の一部であるため、慎重に取り扱う必要があります。公開リポジトリや共有設定ファイルでこの値を露出させないようにしてください。
接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。
カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)
このプロパティ(アプリケーションシークレットまたはコンシューマシークレットとも呼ばれます)は、安全なクライアント認証を必要とするすべてのフローでカスタムOAuth アプリケーションを使用する場合に必要です。たとえば、Web ベースのOAuth、サービスベースの接続、証明書ベースの認可フローなどが該当します。 組み込みOAuth アプリケーションを使用する場合は必要ありません。
クライアントシークレットは、OAuth フローのトークン交換ステップで使用されます。このステップでは、ドライバーが認可サーバーにアクセストークンを要求します。 この値が欠落しているか正しくない場合、認証はinvalid_client またはunauthorized_client エラーで失敗します。
OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。この値は、OAuth アプリケーションを登録する際にID プロバイダーから取得できます。
Notes:
接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。
データへの適切なアクセスを確実にするために、認証ユーザーのアプリケーションへのアクセス範囲を指定します。 カスタムOAuth アプリケーションが必要な場合は、通常、アプリケーションの作成時に指定します。
スコープは、認証ユーザーがどのようなアクセス権を持つかを定義するために設定されます。例えば、読み取り、読み取りと書き込み、機密情報への制限付きアクセスなどです。システム管理者は、スコープを使用して機能またはセキュリティクリアランスによるアクセスを選択的に有効化できます。
InitiateOAuth がGETANDREFRESH に設定されている場合、要求するスコープを変更したい場合はこのプロパティを使用する必要があります。
InitiateOAuth がREFRESH またはOFF のいずれかに設定されている場合、このプロパティまたはScope 入力を使用して、要求するスコープを変更できます。
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。
TLS/SSL 接続を使用している場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。このプロパティに値を指定すると、マシンによって信頼されていない他の証明書はすべて拒否されます。
このプロパティは、次のフォームを取ります:
| 説明 | 例 |
| フルPEM 証明書(例では省略されています) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| 証明書を保有するローカルファイルへのパス。 | C:\cert.cer |
| 公開鍵(例では省略されています) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| MD5 Thumbprint(hex 値はスペースまたはコロン区切り) | ecadbdda5a1529c58a1e9e09828d70e4 |
| SHA1 Thumbprint(hex 値はスペースまたはコロン区切り) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
Note:'*' を使用してすべての証明書を受け入れるように指定することも可能ですが、セキュリティ上の懸念があるため推奨されません。
このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。
| プロパティ | 説明 |
| FirewallType | provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。 |
| FirewallServer | ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。 |
| FirewallPort | プロキシベースのファイアウォールで使用するTCP ポートを指定します。 |
| FirewallUser | プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。 |
| FirewallPassword | プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。 |
provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
Note:デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し、次のプロキシタイプのいずれかに接続するには、ProxyAutoDetect をfalse に設定します。
次の表は、サポートされている各プロトコルのポート番号情報です。
| プロトコル | デフォルトポート | 説明 |
| TUNNEL | 80 | Sync App がMonday への接続を開くポート。トラフィックはこの場所のプロキシを経由して行き来します。 |
| SOCKS4 | 1080 | Sync App がMonday への接続を開くポート。SOCKS 4 は次にFirewallUser 値をプロキシに渡し、接続リクエストが許容されるかどうかを決定します。 |
| SOCKS5 | 1080 | Sync App がMonday にデータを送信するポート。SOCKS 5 プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。 |
HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。
ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールで使用するTCP ポートを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。
| プロパティ | 説明 |
| ProxyAutoDetect | provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。 |
| ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレスを指定します。 |
| ProxyPort | クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバーのTCP ポートを指定します。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名を提供します。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザーのパスワードを指定します。 |
| ProxySSLType | ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプを指定します。 |
| ProxyExceptions | ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリストを指定します。 |
provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
この接続プロパティをTrue に設定すると、Sync App は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします(プロキシサーバーの詳細を手動で入力する必要はありません)。
この接続プロパティは他のプロキシ設定より優先されます。特定のプロキシサーバーに接続するためにSync App を構成する場合は、ProxyAutoDetect をFalse に設定します。
HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。
HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレスを指定します。
ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーを通じてのみHTTP トラフィックをルーティングします。
ProxyAutoDetect がTrue(デフォルト)に設定されている場合、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーを介してHTTP トラフィックをルーティングします。
クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバーのTCP ポートを指定します。
ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたProxyServer ポートを通じてのみHTTP トラフィックをルーティングします。
ProxyAutoDetect がTrue(デフォルト)に設定されている場合、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーポートを介してHTTP トラフィックをルーティングします。
その他のプロキシタイプについては、FirewallType を参照してください。
ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
サポートされる認証の種類:
NONE 以外のすべての値については、ProxyUser およびProxyPassword 接続プロパティも設定する必要があります。
SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。
ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名を提供します。
ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。
ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。
| ProxyAuthScheme の値 | ProxyUser に設定する値 |
| BASIC | プロキシサーバーに登録されているユーザーのユーザー名。 |
| DIGEST | プロキシサーバーに登録されているユーザーのユーザー名。 |
| NEGOTIATE | プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。 |
| NTLM | プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。 |
| NONE | ProxyPassword 接続プロパティは設定しないでください。 |
Note:Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このユーザー名を使用します。 ProxyAutoDetect がTrue(デフォルト)に設定されている場合、Sync App は代わりにシステムのプロキシ設定で指定されているユーザー名を使用します。
ProxyUser 接続プロパティで指定されたユーザーのパスワードを指定します。
ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。
ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。
| ProxyAuthScheme の値 | ProxyPassword に設定する値 |
| BASIC | ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。 |
| DIGEST | ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。 |
| NEGOTIATE | ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。 |
| NTLM | ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。 |
| NONE | ProxyPassword 接続プロパティは設定しないでください。 |
SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。
Note:Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このパスワードを使用します。 ProxyAutoDetect がTrue(デフォルト)に設定されている場合、Sync App は代わりにシステムのプロキシ設定で指定されているパスワードを使用します。
ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプを指定します。
このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この接続プロパティには、以下の値を設定できます。
| AUTO | デフォルト設定。ProxyServer がHTTPS URL に設定されている場合、Sync App は、TUNNEL オプションを使用します。ProxyServer がHTTP URL に設定されている場合、コンポーネントはNEVER オプションを使用します。 |
| ALWAYS | 接続は、常にSSL 有効となります。 |
| NEVER | 接続は、SSL 有効になりません。 |
| TUNNEL | 接続はトンネリングプロキシ経由で行われます。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。 |
ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリストを指定します。
ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。
Note:Sync App はデフォルトでシステムプロキシ設定を使用するため、それ以上の設定は必要ありません。 この接続にプロキシ例外を明示的に設定する場合は、ProxyAutoDetect をFalse に設定します。
このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。
| プロパティ | 説明 |
| LogModules | ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。 |
ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。
Sync App は、実行する各操作の詳細を Logfile 接続プロパティで指定されたログファイルに書き込みます。
ログに記録される各操作は、モジュールと呼ばれるカテゴリに分類されます。各モジュールには対応する短いコードがあり、個々の Sync App の操作がどのモジュールに属するかを示すラベルとして使用されます。
この接続プロパティにモジュールコードをセミコロン区切りのリストで設定すると、指定したモジュールに属する操作のみがログファイルに書き込まれます。この設定は今後のログ記録にのみ適用され、既存のログファイルの内容には影響しません。例: INFO;EXEC;SSL;META;
デフォルトでは、すべてのモジュールの操作がログに含まれます。
モジュールを明示的に除外するには、先頭に「-」を付けます。例: -HTTP
サブモジュールにフィルターを適用するには、<モジュール名>.<サブモジュール名> の構文で指定します。たとえば、次の値を設定すると、Sync App は HTTP モジュールに属するアクションのみをログに記録し、さらに HTTP モジュールの Res サブモジュールに属するアクションを除外します: HTTP;-HTTP.Res
Verbosity 接続プロパティによるログファイルのフィルタリングは、この接続プロパティによるフィルタリングよりも優先されます。そのため、Verbosity 接続プロパティで指定したレベルよりも高い詳細レベルの操作は、この接続プロパティで指定したモジュールに属していても、ログファイルには出力されません。
使用可能なモジュールとサブモジュールは次のとおりです。
| モジュール名 | モジュールの説明 | サブモジュール |
| INFO | 一般情報。接続文字列、製品バージョン(ビルド番号)、および初期接続メッセージが含まれます。 |
|
| EXEC | クエリ実行。ユーザーが記述した SQL クエリ、解析済み SQL クエリ、正規化済み SQL クエリの実行メッセージが含まれます。クエリおよびクエリページの成功/失敗メッセージもここに表示されます。 |
|
| HTTP | HTTP プロトコルメッセージ。HTTP リクエスト/レスポンス(POST メッセージを含む)、および Kerberos 関連のメッセージが含まれます。 |
|
| WSDL | WSDL/XSD ファイルの生成に関するメッセージ。 | — |
| SSL | SSL 証明書メッセージ。 |
|
| AUTH | 認証関連の失敗/成功メッセージ。 |
|
| SQL | SQL トランザクション、SQL 一括転送メッセージ、および SQL 結果セットメッセージが含まれます。 |
|
| META | メタデータキャッシュとスキーマメッセージ。 |
|
| FUNC | SQL 関数の実行に関連する情報。 |
|
| TCP | TCP トランスポートレイヤーメッセージでの送受信生バイト。 |
|
| FTP | File Transfer Protocol に関するメッセージ。 |
|
| SFTP | Secure File Transfer Protocol に関するメッセージ。 |
|
| POP | Post Office Protocol 経由で転送されるデータに関するメッセージ。 |
|
| SMTP | Simple Mail Transfer Protocol 経由で転送されるデータに関するメッセージ。 |
|
| CORE | 他のモジュールでカバーされていない、さまざまな製品内部操作に関連するメッセージ。 | — |
| DEMN | SQL リモーティングに関連するメッセージ。 | — |
| CLJB | 一括データアップロード(クラウドジョブ)に関するメッセージ。 |
|
| SRCE | 他のモジュールに属さない、製品が生成するその他のメッセージ。 | — |
| TRANCE | 低レベルの製品操作に関する高度なメッセージ。 | — |
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。 |
| Views | レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。 |
テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
Location プロパティは、定義をカスタマイズしたり(例えば、カラム名を変更する、カラムを無視するなど)、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。
指定しない場合、デフォルトの場所は%APPDATA%\\CData\\Monday Data Provider\\Schema となり、%APPDATA%はユーザーのコンフィギュレーションディレクトリに設定されます:
| プラットフォーム | %APPDATA% |
| Windows | APPDATA 環境変数の値 |
| Linux | ~/.config |
レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
データベースによっては、利用可能なすべてのテーブルをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にテーブルのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
利用可能なテーブルがたくさんあり、すでに作業したいテーブルが決まっている場合、このプロパティを使用して対象のテーブルのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。
Note:複数のスキーマまたはカタログを持つデータソースに接続する場合は、表示する各テーブルを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するテーブルが混同されることを防ぎます。
レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。
データベースによっては、利用可能なすべてのビューをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にビューのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
利用可能なビューがたくさんあり、すでに作業したいビューが決まっている場合、このプロパティを使用して対象のビューのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。
Note:複数のスキーマまたはカタログを持つデータソースに接続する場合は、確認する各ビューを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するビューが混同されることを防ぎます。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
| プロパティ | 説明 |
| IncludeCustomFields | Set this property to true to include custom fields in queries on applicable tables. |
| MaxPointsPerCall | Specifies the maximum points allowed by the provider for a single API call. |
| MaxRows | 集計やGROUP BY を含まないクエリで返される最大行数を指定します。 |
| Other | 特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。 |
| ServerFirstDayOfWeek | The first day of the week, as defined in your account settings. |
| ServerTimezone | The time zone of your Monday account. |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。 |
| UseDisplayColumnNames | Boolean determining if the column names should match display names or internal API names (IDs). |
| UseDisplaySchemaNames | Boolean determining if the schema names should match display names or internal API names (IDs). |
| UseDisplayTableNames | Boolean determining if the table names should match display names or internal API names (IDs). |
| UserDefinedViews | カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。 |
Set this property to true to include custom fields in queries on applicable tables.
Set this property to true to include custom fields in queries on applicable tables. Note that custom fields are available only with Monday Pro and Enterprise plans.
Specifies the maximum points allowed by the provider for a single API call.
The Sync App translates your SQL queries to Monday API calls. The Monday API assigns a certain number complexity points to all API calls made to it and places limits on how many complexity points worth of calls you can request under various circumstances.
The Sync App ensures that all queries you execute consume at or below the number of complexity points set in this connection property, where possible. If the minimum viable API call needed to fulfill your query exceeds this limit, the Sync App still submits that call, since it cannot be optimized further.
Note that you cannot set a limit that exceeds the hard limits imposed by the Monday API. The total cost of a single query cannot exceed 5,000,000 points. Standard accounts using personal API tokens cannot exceed 10,000,000 points per minute, while trial and free accounts using personal API tokens are limited to 1,000,000 points per minute. Accounts using OAuth are limited to 5,000,000 points per minute.
You can reduce the complexity of API calls by selecting only the necessary columns in your SQL queries, as this affects the depth and structure of the generated GraphQL query.
集計やGROUP BY を含まないクエリで返される最大行数を指定します。
このプロパティのデフォルト値である-1 は、クエリに明示的にLIMIT 句が含まれていない限り、行の制限が適用されないことを意味します。 (クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。)
MaxRows を0より大きい整数に設定することで、クエリがデフォルトで過度に大きな結果セットを返さないようにします。
このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し、過剰なリソース消費を防ぐのに役立ちます。
特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。
このプロパティにより、シニアユーザーはサポートチームのアドバイスに基づいて、特定の状況に対応する隠しプロパティを設定できます。 これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。 複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
Note:特定のシナリオや問題に対処するためにサポートチームから助言があった場合にのみ、これらのプロパティを設定することを強く推奨します。
| プロパティ | 説明 |
| DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
| ConvertDateTimeToGMT=True | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換します。デフォルト値はFalse(ローカルタイムを使用)です。 |
| RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
このプロパティを使用すると、Sync App がテーブルカラムとして公開する擬似カラムを定義できます。
個々の擬似カラムを指定するには、以下の形式を使用します。
Table1=Column1;Table1=Column2;Table2=Column3
すべてのテーブルのすべての擬似カラムを含めるには、次を使用してください:
*=*
The first day of the week, as defined in your account settings.
The allowed values are:
See this page for more information.
The time zone of your Monday account.
This property specifies the time zone used to filter board items by UpdatedAt. By default, the Sync App automatically resolves the time zone.
Possible values include "GMT", "America/New_York", etc.
provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。
タイムアウトはデフォルトで60秒に設定されています。タイムアウトを無効にするには、このプロパティを0に設定します。
タイムアウトを無効にすると、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。
Note: このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。
Boolean determining if the column names should match display names or internal API names (IDs).
Affects only dynamic columns i.e.: columns mapped to Monday board fields.
Boolean determining if the schema names should match display names or internal API names (IDs).
Affects only dynamic schemas i.e.: schemas mapped to Monday workspaces.
Boolean determining if the table names should match display names or internal API names (IDs).
Affects only dynamic tables i.e.: tables mapped to Monday boards.
カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。
UserDefinedViews を使用すると、UserDefinedViews.json というJSON 形式の構成ファイルを通じてカスタムビューを定義および管理できます。 これらのビューはSync App によって自動的に認識され、標準のデータベースビューのようにカスタムSQL クエリを実行できるようになります。 JSON ファイルは、各ビューをルート要素として定義し、その子要素として"query" を持ちます。この"query" にはビューのSQL クエリが含まれています。
次に例を示します。
{
"MyView": {
"query": "SELECT * FROM Invoices WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
このプロパティを使用して、1つのファイルに複数のビューを定義し、ファイルパスを指定できます。
次に例を示します。
UserDefinedViews=C:\Path\To\UserDefinedViews.jsonUserDefinedViews でビューを指定すると、Sync App はそのビューだけを参照します。
詳しくは、ユーザー定義ビュー を参照してください。
LZMA from 7Zip LZMA SDK
LZMA SDK is placed in the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
LZMA2 from XZ SDK
Version 1.9 and older are in the public domain.
Xamarin.Forms
Xamarin SDK
The MIT License (MIT)
Copyright (c) .NET Foundation Contributors
All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
NSIS 3.10
Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
1. DEFINITIONS
"Contribution" means:
a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:
i) changes to the Program, and
ii) additions to the Program;
where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.
"Contributor" means any person or entity that distributes the Program.
"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.
"Program" means the Contributions distributed in accordance with this Agreement.
"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.
2. GRANT OF RIGHTS
a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.
b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.
c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.
d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.
3. REQUIREMENTS
A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:
a) it complies with the terms and conditions of this Agreement; and
b) its license agreement:
i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;
ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;
iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and
iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.
When the Program is made available in source code form:
a) it must be made available under this Agreement; and
b) a copy of this Agreement must be included with each copy of the Program.
Contributors may not remove or alter any copyright notices contained within the Program.
Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.
4. COMMERCIAL DISTRIBUTION
Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.
For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.
5. NO WARRANTY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.
6. DISCLAIMER OF LIABILITY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
7. GENERAL
If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.
All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.
Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.
This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.