Overview
A configuration is provided for establishing connections with the monday service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Demonstration
Quick Start
In this task, we will show you step-by-step how to create a connection to monday REST API using COZYROC's REST Connection Manager.
Step 1. You have to generate a token to connect to the service. Please review the instructions posted here on how to generate the token.
Step 2. Run "Visual Studio" under "Administrator account". Right click on Connection managers Tab and Select New Connection. In Add SSIS Connection Manager scroll down and select Connection managers for REST Connection and click Add.
Step 3. From the drop-down menu Configuration select monday. Enter the monday token you have acquired.
Step 4. Click "Test Connection" to test your connection.
Congratulations! You have now established a connection to your monday instance.
In this guide, we will show how to read data from the monday service resource using the COZYROC REST Source component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open "SSIS Toolbox" and drag and drop COZYROC "REST Source" component.
Step 3. Double click on the "REST Source" component and select monday connection from the combo. Select from available monday resources listed in the second combo below.
Optionally you can include extra parameters in the grid below if needed.
Step 4. Click on the "Columns tab" and select monday resource columns you want to read.
Step 5. Click Preview to make sure all necessary resource columns are included.
Bravo! You have now learned how to read data from monday service.
In this guide, we will show how to write data to the monday service resource using the COZYROC REST Destination component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open the "SSIS Toolbox" and drag and drop COZYROC "REST Destination" component.
Step 3. Double click on the "REST Destination" component and select monday connection from the combo. Also, select resource action and monday resource you want to work on.
Step 4. Click on the "Mapping" tab and map the input columns for the process you are configuring.
If you want to provide input for other resource composite objects, change the input above and map the columns.
Done. You have now learned how to write data into the monday resource.
Configuration
Base URL address: https://api.monday.com/v2.
-
The authentication uses a parameters-based authentication.
The authentication has the following user-defined parameters:
- Token:
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
{{=connection.user.Token}}
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/.
The result is extracted from:{{=response.data.boards}}.The following request parameters will be automatically processed:
-
application/json:
{{=monday.getQuery('boards', '', resource, parameters, _.without(parameters.fields, 'board_name'))}}
Documentation: https://monday.com/developers/v2#queries-section-boards.
-
application/json:
- [Create] action
-
Endpoint URL address:
/.The following request parameters will be automatically processed:
-
application/json:
{{=monday.getMutation('create_board', item)}}
Documentation: https://monday.com/developers/v2#mutations-section-boards.
-
application/json:
The resource includes the fields from the BoardT template.
- items
Field components:
- An array.
-
Uses template:
Item.
- board_name
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/.
The result is extracted from:{{=response.data.items}}.The following request parameters will be automatically processed:
-
application/json:
{{=monday.getQuery('items', '', resource, parameters, _.without(parameters.fields, 'item_name', 'board_id', 'group_id'))}}
Documentation: https://monday.com/developers/v2#queries-section-items.
-
application/json:
- [Read by_column_values] action
-
Endpoint URL address:
/.
The result is extracted from:{{=response.data.items}}.The action has the following user-defined parameters:
- board_id: Required. Specify board identifier.
- column_id: Required. Specify column identifier.
- column_value: Required. Specify column value.
The following request parameters will be automatically processed:
-
application/json:
{{=monday.getQuery( 'items', 'board_id: ' + parameters.board_id + ', ' + 'column_id: "' + parameters.column_id + '", ' + 'column_value: "' + parameters.column_value + '", ', resource, parameters)}}
Documentation: https://monday.com/developers/v2#queries-section-items-by-column-values.
- [Create] action
-
Endpoint URL address:
/.The following request parameters will be automatically processed:
-
application/json:
{{=monday.getMutation('create_item', item)}}
Documentation: https://monday.com/developers/v2#mutations-section-items-create.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/.The following request parameters will be automatically processed:
-
application/json:
{{=monday.getMutation('delete_item', item)}}
Documentation: https://monday.com/developers/v2#mutations-section-items-delete.
-
application/json:
The resource includes the fields from the Item template.
- item_name
Template: ShortText.
- board_id
Template: ShortText.
- group_id
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/.
The result is extracted from:{{=response.data.updates}}.The following request parameters will be automatically processed:
-
application/json:
{{=monday.getQuery('updates', '', resource, parameters)}}
Documentation: https://monday.com/developers/v2#queries-section-updates.
-
application/json:
- [Create] action
-
Endpoint URL address:
/.The following request parameters will be automatically processed:
-
application/json:
{{=monday.getMutation('create_update', item)}}
Documentation: https://monday.com/developers/v2#mutations-section-updates-create.
-
application/json:
The resource includes the fields from the Update template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/.
The result is extracted from:{{=response.data.tags}}.The following request parameters will be automatically processed:
-
application/json:
{{=monday.getQuery('tags', '', resource, parameters, _.without(parameters.fields, 'tag_name', 'board_id'))}}
Documentation: https://monday.com/developers/v2#queries-section-tags.
-
application/json:
- [Create] action
-
Endpoint URL address:
/.The following request parameters will be automatically processed:
-
application/json:
{{=monday.getMutation('create_or_get_tag', item)}}
Documentation: https://monday.com/developers/v2#mutations-section-tags-get-or-create-tag.
-
application/json:
The resource includes the fields from the Tag template.
- tag_name
Template: ShortText.
- board_id
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/.
The result is extracted from:{{=response.data.users}}.The following request parameters will be automatically processed:
-
application/json:
{{=monday.getQuery('users', '', resource, parameters)}}
Documentation: https://monday.com/developers/v2#queries-section-users.
-
application/json:
The resource includes the fields from the User template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/.
The result is extracted from:{{=response.data.teams}}.The following request parameters will be automatically processed:
-
application/json:
{{=monday.getQuery('teams', '', resource, parameters)}}
Documentation: https://monday.com/developers/v2#queries-section-teams.
-
application/json:
The resource includes the fields from the Team template.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/.The following request parameters will be automatically processed:
-
application/json:
{{=monday.getMutation('create_column', item)}}
Documentation: https://monday.com/developers/v2#mutations-section-columns-creating.
-
application/json:
- [Update] action
-
Endpoint URL address:
/.The following request parameters will be automatically processed:
-
application/json:
{{=monday.getMutation('change_column_value', item)}}
Documentation: https://monday.com/developers/v2#mutations-section-columns-change-column-value.
-
application/json:
- board_id
Template: ShortText.
- title
Template: ShortText.
- column_type
Template: ShortText.
- defaults
Template: ShortText.
- item_id
Template: ShortText.
- column_id
Template: ShortText.
- value
Template: ShortText.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/.The following request parameters will be automatically processed:
-
application/json:
{{=monday.getMutation('create_group', item)}}
Documentation: https://monday.com/developers/v2#mutations-section-groups-create.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/.The following request parameters will be automatically processed:
-
application/json:
{{=monday.getMutation('delete_group', item)}}
Documentation: https://monday.com/developers/v2#mutations-section-groups-delete.
-
application/json:
- board_id
Template: ShortText.
- group_name
Template: ShortText.
- group_id
Template: ShortText.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/.The following request parameters will be automatically processed:
-
application/json:
{{=monday.getMutation('create_notification', item)}}
Documentation: https://monday.com/developers/v2#mutations-section-notifications-create.
-
application/json:
- text
Template: ShortText.
- user_id
Template: ShortText.
- target_id
Template: ShortText.
- target_type
Template: ShortText.
- payload
Template: LongText.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/.The following request parameters will be automatically processed:
-
application/json:
{{=monday.getMutation('create_webhook', item)}}
Documentation: https://monday.com/developers/v2#mutations-section-webhooks-create.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/.The following request parameters will be automatically processed:
-
application/json:
{{=monday.getMutation('delete_webhook', item)}}
Documentation: https://monday.com/developers/v2#mutations-section-webhooks-delete.
-
application/json:
- id
A key field. Data type: DT_I4
- board_id
Template: ShortText.
- url
Template: ShortText.
- event
Template: ShortText.
- [Read] action
-
The action uses POST method.
The result is paginated.
- [Create] action
-
The action uses POST method.
- [Update] action
-
The action uses PUT method.
- [Delete] action
-
The action uses DELETE method.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Date
Data type: DT_DBDATE
- Account
Field components:
- Contains the following components: id, name.
- Team
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, picture_url, users.
-
Uses template:
- User
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, account, birthday, country_code, created_at, email, enabled, is_guest, is_pending, join_date, location, mobile_phone, phone, photo_original, photo_small, photo_thumb, photo_thumb_small, photo_tiny, teams, time_zone_identifier, title, url, utc_hours_diff.
-
Uses template:
- Column
Field components:
-
Uses template:
ShortText. - Contains the following components: id, title, archived, settings_str, type, width.
-
Uses template:
- Group
Field components:
-
Uses template:
ShortText. - Contains the following components: id, title, archived, color, deleted, items, position.
-
Uses template:
- Tag
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, color.
-
Uses template:
- BoardT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, board_folder_id, board_kind, columns, description, groups, owner, permissions, pos, state, subscribers, tags, top_group.
-
Uses template:
- Update
Field components:
-
Uses template:
LongText. - Contains the following components: id, body, created_at, creator, creator_id, item_id, replies, text_body, updated_at.
-
Uses template:
- Item
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, board, column_values, created_at, creator, creator_id, group, state, subscribers, updated_at, updates.
-
Uses template:
What's New
- Breaking Change: Configuration is now based on new GraphQL protocol support.
- Fixed: Modified not to perform pagination for resources that do not support it.
- New: Introduced connection.
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.