Overview
Configuration is provided for establishing connections with Airtable 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 Airtable REST API using COZYROC's REST Connection Manager.
Step 1. 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 2. From drop-down menu Configuration select Airtable. Then click New in the Token File parameter to create a new token file.
Step 2. In the Next Wizard specify the Base Id for the Base parameter. You can also add scopes to the default scope list or modify base on your needs for the scope parameter. Click on Next button
Step 4: Provide Email. Then press 'continue button.
Step 5: Provide Password. Then press 'Sign in button.
Step 6: In the next wizard click on Add a base to select the base you want to generate the token for. Then click on Authorize button.
Step 7: Save generated access token to file. Specify token protection password. Click OK.
Step 8. Click "Test Connection" to test your connection.
Congratulations! You have now established a connection to your Airtable instance.
In this task, we will show you step-by-step how to create a connection using personal access token to Airtable REST API using COZYROC's REST Connection Manager.
Step 1. 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 2. From drop-down menu Configuration select Airtable. Provide the value for PAT and Base parameters in the grid below.
Step 3. Click "Test Connection" to test your connection.
Congratulations! You have now established a connection to your Airtable instance.
In this guide, we will show how to read data from the Airtable 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 Airtable connection from the combo. Select from available Airtable 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 Airtable 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 Airtable service.
In this guide, we will show how to write data to the Airtable 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 Airtable connection from the combo. Also, select resource action and Airtable 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 Airtable resource.
Configuration
Base URL address: https://api.airtable.com/v0/[base id].
- OAuth 2
-
The authentication uses an authorized token. The token will be refreshed with the following expression:
{{=Date.now() + (response.expires_in - 300) * 1000}}.The authentication has the following user-defined parameters:
- Base: Required. Specify the base identifier.
- Scope:
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Documentation: https://airtable.com/developers/web/api/oauth-reference.
- PersonalAccessToken
-
The authentication uses a parameters-based authentication.
The authentication has the following user-defined parameters:
- PAT: Required. Specify API key.
- Base: Required. Specify the base identifier.
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=connection.user.PAT}}
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/{{=Airtable.UI.TableEditor.getValue(parameters)}}/{{=parameters.recordId}}/comments.
The result is extracted from:{{=response.comments}}.The action has the following user-defined parameters:
- Table: Required. Specify the table name.
- recordId: Required. Specify the record id.
Documentation: https://airtable.com/developers/web/api/list-comments.
- [Create] action
-
Endpoint URL address:
/{{=Airtable.UI.TableEditor.getValue(parameters)}}/{{=parameters.recordId}}/comments.The action has the following user-defined parameters:
- Table: Required. Specify the table name or identifier.
- recordId: Required. Specify the record id.
Documentation: https://airtable.com/developers/web/api/create-comment.
- [Update] action
-
Endpoint URL address:
/{{=Airtable.UI.TableEditor.getValue(parameters)}}/{{=parameters.recordId}}/comments/{{=item.id}}.The action has the following user-defined parameters:
- Table: Required. Specify the table name or identifier.
- recordId: Required. Specify the record id.
Documentation: https://airtable.com/developers/web/api/update-comment.
- [Delete] action
-
Endpoint URL address:
/{{=Airtable.UI.TableEditor.getValue(parameters)}}/{{=parameters.recordId}}/comments/{{=item.id}}.The action has the following user-defined parameters:
- Table: Required. Specify the table name or identifier.
- recordId: Required. Specify the record id.
The following request parameters will be automatically processed:
-
application/json:
{{={ id: item.id, deleted : true } }}
Documentation: https://airtable.com/developers/web/api/update-comment.
- id
A key field. Template: ShortText.
- author
Field components:
-
Uses template:
ShortText. - Contains the following components: id, email, name.
-
Uses template:
- createdTime
Template: DateTime. A read-only field.
- lastUpdatedTime
Template: DateTime. A read-only field.
- text
Template: LongText.
Based on resource template NoPagination.
- [Read] action
-
The result is extracted from:{{=_.find(Airtable.getTables(), function(table) { return table.name == parameters.Table; }).fields}}.The action has the following user-defined parameters:
- Table: Required. Specify the table name or identifier.
- [Create] action
-
Endpoint URL address:
{{=Airtable.getMetaBase()}}/tables/{{=Airtable.UI.TableEditor.getValue(parameters)}}/fields.The action has the following user-defined parameters:
- Table: Required. Specify the table name or identifier.
Documentation: https://airtable.com/developers/web/api/list-comments.
- [Update] action
-
Endpoint URL address:
{{=Airtable.getMetaBase()}}/tables/{{=Airtable.UI.TableEditor.getValue(parameters)}}/fields/{{=item.id}}.The action has the following user-defined parameters:
- Table: Required. Specify the table name or identifier.
- recordId: Required. Specify the record id.
Documentation: https://airtable.com/developers/web/api/update-field.
The resource includes the fields from the FieldT template.
Based on resource template NoPagination.
- [Read] action
-
The result is extracted from:{{=Airtable.getTables()}}.
- [Create] action
-
Endpoint URL address:
{{=Airtable.getMetaBase()}}/tables.Documentation: https://airtable.com/developers/web/api/create-table.
- [Update] action
-
Endpoint URL address:
{{=Airtable.getMetaBase()}}/tables/{{=Airtable.UI.TableEditor.getValue(parameters)}}.The action has the following user-defined parameters:
- Table: Required. Specify the table name or identifier.
Documentation: https://airtable.com/developers/web/api/create-table.
- id
A key field. Template: ShortText.
- description
Template: LongText.
- name
Template: ShortText.
- type
Template: ShortText.
- primaryFieldId
Template: ShortText.
- fields
Field components:
- An array.
-
Uses template:
FieldT.
- views
Field components:
- An array.
- Contains the following components: id, name, type.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
{{=Airtable.getMetaBase('')}}.
The result is extracted from:{{=response.bases}}.
The result is paginated.The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
pageSize:
{{=undefined}}
Documentation: https://airtable.com/developers/web/api/list-bases.
-
offset:
- [Create] action
-
Endpoint URL address:
{{=Airtable.getMetaBase('')}}.Documentation: https://airtable.com/developers/web/api/create-base.
- [Delete] action
-
Endpoint URL address:
{{=Airtable.getMetaBase(item.id)}}.Documentation: https://airtable.com/developers/web/api/delete-base.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- permissionLevel
Template: ShortText.
- tables
Field components:
- An array.
- Contains the following components: name, description, fields.
- action
Template: ShortText. Field components:
-
Uses template:
ActionT. - Contains the following components: move, deleteInvite.
-
Uses template:
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/bases/{{=Airtable.UI.BaseEditor.getValue(parameters)}}/webhooks.
The result is extracted from:{{=response.webhooks}}.The action has the following user-defined parameters:
- Base: Required. Specify the base name or identifier.
Documentation: https://airtable.com/developers/web/api/list-webhooks.
- [Create] action
-
Endpoint URL address:
/bases/{{=Airtable.UI.BaseEditor.getValue(parameters)}}/webhooks.The action has the following user-defined parameters:
- Base: Required. Specify the base name or identifier.
Documentation: https://airtable.com/developers/web/api/create-a-webhook.
- [Delete] action
-
Endpoint URL address:
/bases/{{=Airtable.UI.BaseEditor.getValue(parameters)}}/webhook/{{=item.id}}.The action has the following user-defined parameters:
- Base: Required. Specify the base name or identifier.
Documentation: https://airtable.com/developers/web/api/delete-a-webhook.
- id
A key field. Template: ShortText.
- areNotificationsEnabled
Data type: DT_BOOL
- cursorForNextPayload
Data type: DT_I4
- expirationTime
Template: DateTime.
- isHookEnabled
Data type: DT_BOOL
- lastNotificationResult
Field components:
-
Uses template:
DateTime. - Contains the following components: completionTimestamp, durationMs, retryNumber, success.
-
Uses template:
- lastSuccessfulNotificationTime
Template: DateTime.
- notificationUrl
Template: ShortText.
- specification
Field components:
- Contains the following components: options.
- action
Template: ShortText. Field components:
-
Uses template:
ActionT. - Contains the following components: EnableorDisable, refresh.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/bases/{{=Airtable.UI.BaseEditor.getValue(parameters)}}/webhooks/{{=parameters.webhookId}}/payloads.
The result is extracted from:{{=response.payloads}}.
The result is paginated.The action has the following user-defined parameters:
- Base: Required. Specify the base name or identifier.
- webhookId: Required. Specify the webhook identifier.
The following request parameters will be automatically processed:
-
cursor:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}}
Documentation: https://airtable.com/developers/web/api/list-webhook-payloads.
- actionMetadata
Field components:
-
Uses template:
ShortText. - Contains the following components: source, sourceMetadata.
-
Uses template:
- baseTransactionNumber
Data type: DT_I4
- payloadFormat
Template: ShortText.
- timestamp
Template: DateTime. A read-only field.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
{{=Airtable.getMetaBase(Airtable.UI.BaseEditor.getValue(parameters))}}/views.
The result is extracted from:{{=response.views}}.The action has the following user-defined parameters:
- Base: Required. Specify the base name or identifier.
Documentation: https://airtable.com/developers/web/api/list-views.
- [Read single] action
-
Endpoint URL address:
{{=Airtable.getMetaBase(Airtable.UI.BaseEditor.getValue(parameters))}}/views/{{=parameters.viewId}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- Base: Required. Specify the base name or identifier.
- viewId: Required. Specify the view identifier.
Documentation: https://airtable.com/developers/web/api/get-view-metadata.
- [Delete] action
-
Endpoint URL address:
{{=Airtable.getMetaBase(Airtable.UI.BaseEditor.getValue(parameters))}}/views/{{=item.id}}.The action has the following user-defined parameters:
- Base: Required. Specify the base name or identifier.
Documentation: https://airtable.com/developers/web/api/get-view-metadata.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- personalForUserId
Template: ShortText.
- type
Template: ShortText.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
{{=Airtable.getMetaBase(Airtable.UI.BaseEditor.getValue(parameters))}}/shares.
The result is extracted from:{{=response.shares}}.The action has the following user-defined parameters:
- Base: Required. Specify the base name or identifier.
Documentation: https://airtable.com/developers/web/api/list-shares.
- [Update] action
-
Endpoint URL address:
{{=Airtable.getMetaBase(Airtable.UI.BaseEditor.getValue(parameters))}}/shares/{{=item.shareId}}.The action has the following user-defined parameters:
- Base: Required. Specify the base name or identifier.
Documentation: https://airtable.com/developers/web/api/manage-share.
- [Delete] action
-
Endpoint URL address:
{{=Airtable.getMetaBase(Airtable.UI.BaseEditor.getValue(parameters))}}/shares/{{=item.shareId}}.The action has the following user-defined parameters:
- Base: Required. Specify the base name or identifier.
Documentation: https://airtable.com/developers/web/api/delete-share.
- shareId
A key field. Template: ShortText.
- createdByUserId
Template: ShortText.
- createdTime
Template: DateTime.
- effectiveEmailDomainAllowList
Template: LongText. A composite field.
- isPasswordProtected
Data type: DT_BOOL
- restrictedToEmailDomains
Template: LongText. A composite field.
- shareTokenPrefix
Template: ShortText.
- state
Template: ShortText.
- type
Template: ShortText.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
{{=Airtable.getAccountBase(parameters.accountId)}}.
The result is extracted from:{{=_.map(response.workspaceIds, function(id) { return { id: id }; })}}.The action has the following user-defined parameters:
- accountId: Required. Specify the enterprise account identifier.
Documentation: https://airtable.com/developers/web/api/get-user-group.
- [Update] action
-
Endpoint URL address:
{{=Airtable.getWorkspaceBase(item.id)}}/updateRestrictions.Documentation: https://airtable.com/developers/web/api/update-workspace-restrictions.
- [Delete] action
-
Endpoint URL address:
{{=Airtable.getWorkspaceBase(item.id)}}.Documentation: https://airtable.com/developers/web/api/delete-workspace.
- id
A key field. Template: ShortText.
- inviteCreationRestriction
Template: ShortText.
Based on resource template NoPagination.
- [Read base] action
-
Endpoint URL address:
{{=Airtable.getMetaBase(Airtable.UI.BaseEditor.getValue(parameters))}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- Base: Required. Specify the base name or identifier.
Documentation: https://airtable.com/developers/web/api/get-base-collaborators.
- [Read interface] action
-
Endpoint URL address:
{{=Airtable.getMetaBase(Airtable.UI.BaseEditor.getValue(parameters))}}/interfaces/{{=parameters.pageBundleId}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- Base: Required. Specify the base name or identifier.
- pageBundleId: Required. Specify page bundle id.
Documentation: https://airtable.com/developers/web/api/get-base-collaborators.
- [Read workspace] action
-
Endpoint URL address:
{{=Airtable.getWorkspaceBase(parameters.workspaceId)}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- workspaceId: Required. Specify the workspace identifier.
Documentation: https://airtable.com/developers/web/api/get-workspace-collaborators.
- [Create] action
-
Endpoint URL address:
{{=Airtable.getMetaBase(item.metaBase)}}/collaborators.The following request parameters will be automatically processed:
-
application/json:
{{={ collaborators: addCollaborators } }}
-
application/json:
- [Delete] action
-
Endpoint URL address:
{{=Airtable.getMetaBase(item.metaBase)}}/collaborators/{{=item.id}}.
- id
A key field. Template: ShortText.
- baseIds
Template: LongText. A read-only field. A composite field.
- collaborators
A read-only field. Field components:
- Contains the following components: baseCollaborators, workspaceCollaborators.
- createdTime
Template: DateTime. A read-only field.
- groupCollaborators
A read-only field. Field components:
- Contains the following components: baseCollaborators, workspaceCollaborators.
- individualCollaborators
A read-only field. Field components:
- Contains the following components: baseCollaborators, workspaceCollaborators.
- inviteLinks
A read-only field. Field components:
- Contains the following components: baseInviteLinks, workspaceInviteLinks.
- name
Template: ShortText. A read-only field.
- workspaceRestrictions
A read-only field. Field components:
-
Uses template:
ShortText. - Contains the following components: inviteCreationRestriction, shareCreationRestriction.
-
Uses template:
- addCollaborators
Field components:
- An array.
- Contains the following components: permissionLevel, user.
- metaBase
-
Template: ShortText.
Documentation: Required. Specify meta base like 'meta/bases/baseId'.
Based on resource template NoPagination.
- [Read single] action
-
Endpoint URL address:
{{=Airtable.getAccountBase(parameters.accountId)}}/users/{{=parameters.userId}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- accountId: Required. Specify the enterprise account identifier.
- userId: Required. Specify the user identifier.
Documentation: https://airtable.com/developers/web/api/get-user-by-id.
- [Read email] action
-
Endpoint URL address:
{{=Airtable.getAccountBase(parameters.accountId)}}/users.
The result is extracted from:{{=response.users}}.The action has the following user-defined parameters:
- accountId: Required. Specify the enterpriseAccount identifier.
- email: Required. Please specify comma (,) separated list of email.
The following request parameters will be automatically processed:
-
email:
{{=parameters.email.split(',')}} -
include:
{{=parameters.get('include') && parameters.include.split(',')}}
Documentation: https://airtable.com/developers/web/api/get-user-by-email.
- [Read group] action
-
Endpoint URL address:
{{=Airtable.getGroupBase(parameters.groupId)}}.
The result is extracted from:{{=_.map( response.members, function(member) { return _.extend({ id: member.userId }, member); } )}}.The action has the following user-defined parameters:
- groupId: Required. Specify the group identifier.
Documentation: https://airtable.com/developers/web/api/get-user-group.
- [Read account] action
-
Endpoint URL address:
{{=Airtable.getAccountBase(parameters.accountId)}}.
The result is extracted from:{{=_.map( response.userIds, function(id) { return connection.execute({ url: Airtable.getAccountBase(parameters.accountId) + '/users/' + id }); } )}}.The action has the following user-defined parameters:
- accountId: Required. Specify the enterprise account identifier.
Documentation: https://airtable.com/developers/web/api/get-enterprise.
- [Update] action
-
Endpoint URL address:
{{=Airtable.getAccountBase(item.accountId)}}/users/{{=item.id}}.Documentation: https://airtable.com/developers/web/api/manage-user.
- [Delete] action
-
Endpoint URL address:
{{=Airtable.getAccountBase(item.accountId)}}/users/{{=item.id}}.The following request parameters will be automatically processed:
-
email:
{{=item.email}}
Documentation: https://airtable.com/developers/web/api/delete-user-by-id.
-
email:
- id
A key field. Template: ShortText.
- collaborations
A read-only field. Field components:
- Contains the following components: baseCollaborations, interfaceCollaborations, workspaceCollaborations.
- createdTime
Template: DateTime. A read-only field.
Template: ShortText.
- groups
Field components:
- An array.
- invitedToAirtableByUserId
Template: ShortText.
- isManagedUser
Data type: DT_BOOL
- lastActivityTime
Template: DateTime. A read-only field.
- name
Template: ShortText. A read-only field.
- state
Template: ShortText.
- accountId
Template: ShortText.
- firstName
Template: ShortText.
- lastName
Template: ShortText.
- action
Template: ShortText. Field components:
-
Uses template:
ActionT. - Contains the following components: regenerateAPIKey, removeFromEnterprise, clearAPIKey, logoutUser.
-
Uses template:
Based on resource template NoPagination.
- [Read single] action
-
Endpoint URL address:
{{=Airtable.getGroupBase(parameters.groupId)}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- groupId: Required. Specify the group identifier.
Documentation: https://airtable.com/developers/web/api/get-user-group.
- [Read user] action
-
Endpoint URL address:
{{=Airtable.getAccountBase(parameters.accountId)}}/users/{{=parameters.userId}}.
The result is extracted from:{{=_.map( response.groups, function(group) { return connection.execute({ url: Airtable.getGroupBase(group.id) }); } )}}.The action has the following user-defined parameters:
- accountId: Required. Specify the enterprise account identifier.
- userId: Required. Specify the user identifier.
Documentation: https://airtable.com/developers/web/api/get-user-by-id.
- [Read account] action
-
Endpoint URL address:
{{=Airtable.getAccountBase(parameters.accountId)}}.
The result is extracted from:{{=_.map( response.groupIds, function(id) { return connection.execute({ url: Airtable.getGroupBase(id) }); } )}}.The action has the following user-defined parameters:
- accountId: Required. Specify the enterprise account identifier.
Documentation: https://airtable.com/developers/web/api/get-enterprise.
- id
A key field. Template: ShortText.
- collaborations
Field components:
- Contains the following components: baseCollaborations, interfaceCollaborations, workspaceCollaborations.
- createdTime
Template: DateTime. A read-only field.
- enterpriseAccountId
Template: ShortText.
- members
Field components:
- An array.
- Contains the following components: createdTime, email, firstName, lastName, role, userId.
- name
Template: ShortText.
- updatedTime
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
{{=Airtable.getAccountBase(parameters.accountId)}}/auditLogs.
The result is extracted from:{{=response.auditLogs}}.The action has the following user-defined parameters:
- accountId: Required. Specify the enterprise account identifier.
Documentation: https://airtable.com/developers/web/api/list-audit-log-requests.
- [Read single] action
-
Endpoint URL address:
{{=Airtable.getAccountBase(parameters.accountId)}}/auditLogs/{{=parameters.auditLogTaskId}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- accountId: Required. Specify the enterprise account identifier.
- auditLogTaskId: Required. Specify the enterprise auditLog task identifier.
Documentation: https://airtable.com/developers/web/api/get-audit-log-request.
- [Create] action
-
Endpoint URL address:
{{=Airtable.getAccountBase(parameters.accountId)}}/auditLogs.The action has the following user-defined parameters:
- accountId: Required. Specify the enterpriseAccount identifier.
Documentation: https://airtable.com/developers/web/api/create-audit-log-request.
- id
A key field. Template: ShortText.
- createdByUserId
Template: ShortText. A read-only field.
- createdTime
Template: DateTime. A read-only field.
- data
A read-only field. Field components:
-
Uses template:
DateTime. - Contains the following components: expirationTime, logFileUrls.
-
Uses template:
- state
Template: ShortText. A read-only field.
- filter
Template: ShortText.
- timePeriod
Template: ShortText.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
{{=Airtable.getMetaBase(Airtable.UI.BaseEditor.getValue(parameters))}}/blockInstallations.The action has the following user-defined parameters:
- Base: Required. Specify the base name or identifier.
Documentation: https://airtable.com/developers/web/api/list-block-installations.
- [Update] action
-
Endpoint URL address:
{{=Airtable.getMetaBase(Airtable.UI.BaseEditor.getValue(parameters))}}/blockInstallations/{{=item.id}}.The action has the following user-defined parameters:
- Base: Required. Specify the base name or identifier.
Documentation: https://airtable.com/developers/web/api/manage-block-installation.
- [Delete] action
-
Endpoint URL address:
{{=Airtable.getMetaBase(Airtable.UI.BaseEditor.getValue(parameters))}}/blockInstallations/{{=item.id}}.The action has the following user-defined parameters:
- Base: Required. Specify the base name or identifier.
Documentation: https://airtable.com/developers/web/api/delete-block-installation.
- id
A key field. Template: ShortText.
- blockId
Template: ShortText. A read-only field.
- blockSlug
Template: ShortText. A read-only field.
- createdByUserId
Template: ShortText. A read-only field.
- createdTime
Template: DateTime. A read-only field.
- state
Template: ShortText.
Based on resource template SCIM.
- [Read] action
-
Endpoint URL address:
https://airtable.com/scim/v2/Users.Documentation: https://airtable.com/developers/web/api/list-scim-users.
- [Read single] action
-
Endpoint URL address:
https://airtable.com/scim/v2/Users/{{=parameters.userId}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- userId: Required. Specify the user identifier.
Documentation: https://airtable.com/developers/web/api/get-scim-user.
- [Create] action
-
Endpoint URL address:
https://airtable.com/scim/v2/Users.Documentation: https://airtable.com/developers/web/api/create-scim-user.
- [Update] action
-
Endpoint URL address:
https://airtable.com/scim/v2/Users/{{=item.id}}.
The action uses PUT method.Documentation: https://airtable.com/developers/web/api/put-scim-user.
- id
A key field. Template: ShortText.
- active
Data type: DT_BOOL
- emails
A read-only field. Field components:
- An array.
- meta
A read-only field. Field components:
-
Uses template:
DateTime. - Contains the following components: created, location, resourceType.
-
Uses template:
- name
Field components:
-
Uses template:
ShortText. - Contains the following components: familyName, givenName.
-
Uses template:
- schemas
Template: LongText. A composite field.
- userName
Template: ShortText.
Based on resource template SCIM.
- [Read] action
-
Endpoint URL address:
https://airtable.com/scim/v2/Groups.Documentation: https://airtable.com/developers/web/api/list-scim-groups.
- [Read single] action
-
Endpoint URL address:
https://airtable.com/scim/v2/Groups/{{=parameters.groupId}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- groupId: Required. Specify the group identifier.
Documentation: https://airtable.com/developers/web/api/get-scim-group.
- [Create] action
-
Endpoint URL address:
https://airtable.com/scim/v2/Groups.Documentation: https://airtable.com/developers/web/api/create-scim-group.
- [Update] action
-
Endpoint URL address:
https://airtable.com/scim/v2/Groups/{{=item.id}}.
The action uses PUT method.Documentation: https://airtable.com/developers/web/api/put-scim-group.
- [Delete] action
-
Endpoint URL address:
https://airtable.com/scim/v2/Groups/{{=item.id}}.Documentation: https://airtable.com/developers/web/api/delete-scim-group.
- id
A key field. Template: ShortText.
- displayName
Template: ShortText.
- members
A read-only field. Field components:
- An array.
- schemas
Template: LongText. A composite field.
- [Read] action
-
Endpoint URL address:
/{{=resource.external.id}}.
The result is extracted from:{{=response.records}}.The following request parameters will be automatically processed:
-
fields:
{{=_.filter( _.without(parameters.fields, 'id', 'createdTime'), function(field) { return field.indexOf('.') == -1; } )}}
Documentation: https://airtable.com/developers/web/api/list-records.
-
fields:
- [Read single] action
-
Endpoint URL address:
/{{=resource.external.id}}/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Specify the record identifier.
The following request parameters will be automatically processed:
-
pageSize:
{{=undefined}}
Documentation: https://airtable.com/developers/web/api/get-record.
- [Create] action
-
Endpoint URL address:
/{{=resource.external.id}}.
The result is extracted from:{{=undefined}}.The following request parameters will be automatically processed:
-
application/json:
{{={ records: _.map(batch, function(item) { return { fields: item }; }), typecast: parameters.get('typecast') } }}
Documentation: https://airtable.com/developers/web/api/create-records.
-
application/json:
- [Update] action
-
Endpoint URL address:
/{{=resource.external.id}}.
The result is extracted from:{{=undefined}}.The following request parameters will be automatically processed:
-
application/json:
{{={ records: _.map(batch, function(item) { return { id: item.id, fields: item }; }), typecast: parameters.get('typecast') } }}
Documentation: https://airtable.com/developers/web/api/update-multiple-records.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/{{=resource.external.id}}.
The result is extracted from:{{=undefined}}.The following request parameters will be automatically processed:
-
application/json:
{{={ records: _.map(batch, function(item) { return { id: item.id, deleted: true }; }) } }}
Documentation: https://airtable.com/developers/web/api/delete-multiple-records.
-
application/json:
- id
A key field. Template: ShortText.
- createdTime
Template: DateTime. A read-only field.
- [External]
-
The external fields list is extracted from:
{{=_.find(Airtable.getTables(), function(table) { return table.name == resource.name; }).fields}}.- {{=external.name}}
Template: {{=Airtable.getFieldTemplate(external.type)}}. The gathered value is processed with
{{=item.fields[field.external.name]}}expression.
The external resource list is extracted from: {{=Airtable.getTables()}}.
Based on resource template Base.
- [Read] action
-
The result is paginated.The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
pageSize:
{{=parameters.batchSize}} -
_includeUserParameters:
{{=parameters}}
-
offset:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Update] action
-
The action uses PATCH method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Delete] action
-
The action uses DELETE method.
- [Read] action
-
The result is extracted from:{{=response.Resources}}.
The result is paginated.The following request parameters will be automatically processed:
-
startIndex:
{{=parameters.iterator}} -
count:
{{=parameters.batchSize}} -
_includeUserParameters:
{{=parameters}}
-
startIndex:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Update] action
-
The action uses PATCH method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Delete] action
-
The action uses DELETE method.
- [Read] action
-
The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
-
_includeUserParameters:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Update] action
-
The action uses PATCH method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [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
- Collaborator
Field components:
-
Uses template:
ShortText. - Contains the following components: id, email, name.
-
Uses template:
- Attachment
Field components:
-
Uses template:
ShortText. - Contains the following components: id, url, filename, type, size.
-
Uses template:
- Numeric
Data type: DT_R8
- Boolean
Data type: DT_BOOL
- Integer
Data type: DT_I4
- Formula
Field components:
-
Uses template:
ShortText. - Contains the following components: specialValue.
-
Uses template:
- Barcode
Field components:
-
Uses template:
ShortText. - Contains the following components: text.
-
Uses template:
- MultiSelect
Template: LongText. A composite field. The gathered value is processed with
{{=item.fields[field.name] && item.fields[field.name].join(',')}}expression.- ChoiceT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, color.
-
Uses template:
- DateFormatT
Field components:
-
Uses template:
ShortText. - Contains the following components: format, name, timeZone.
-
Uses template:
- TimeFormatT
Field components:
-
Uses template:
ShortText. - Contains the following components: format, name.
-
Uses template:
- OptionT
Field components:
-
Uses template:
ShortText. - Contains the following components: color, icon, isReversed, isValid, recordLinkFieldId, result, precision, symbol, dateFormat, timeFormat, durationFormat, referencedFieldIds, linkedTableId, prefersSingleRecordLink, inverseLinkFieldId, viewIdForRecordSelection, fieldIdInLinkedTable, choices, max.
-
Uses template:
- FieldT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, description, name, type, options.
-
Uses template:
- CollaboratorT
Field components:
-
Uses template:
ShortText. - Contains the following components: baseId, createdTime, email, grantedByUserId, permissionLevel, userId, groupId, name.
-
Uses template:
- InviteLinkT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, baseId, createdTime, invitedEmail, permissionLevel, referredByUserId, restrictedToEmailDomains, type.
-
Uses template:
- ActionT
Knowledge Base
What's New
- 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.