Airtableconnector v1.1 | OneTeg Documentation

Version 1.1

Connector Overview: This page documents all 17 actions for the Airtableconnector v1.1.

Bases (3)

POST Create base

/meta/bases

Create a new base in your Airtable account.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Name`	The name to assign to the new base.
`Workspaceid`	The identifier of the workspace where the base should be created.

GET Get base schema

/meta/bases/{baseId}/tables

Retrieve the schema of a base, including its tables and fields.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Baseid`	The unique identifier of the base whose schema to fetch.
`Response Type`	The response format expected from the API (e.g. application/json).

GET List bases

/meta/bases

Retrieve a list of all bases accessible to the authenticated user.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

Comments (4)

POST Create comment

/{baseId}/{tableName}/{recordId}/comments

Add a comment to a specific record in a table.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Baseid`	The identifier of the base containing the record.
`Tablename`	The name of the table containing the record.
`Recordid`	The identifier of the record to comment on.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Text`	The content of the comment to create.

DELETE Delete comment

/{baseId}/{tableName}/{recordId}/comments/{rowCommentId}

Permanently delete a specific comment from a record.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Baseid`	The identifier of the base containing the record.
`Tablename`	The name of the table containing the record.
`Recordid`	The identifier of the record whose comment to delete.
`Rowcommentid`	The identifier of the comment to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

GET List comments

/{baseId}/{tableName}/{recordId}/comments

Retrieve all comments associated with a specific record.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Baseid`	The identifier of the base containing the record.
`Tablename`	The name of the table containing the record.
`Recordid`	The identifier of the record whose comments to list.
`Response Type`	The response format expected from the API (e.g. application/json).

PATCH Update comment

/{baseId}/{tableName}/{recordId}/comments/{rowCommentId}

Update the text of an existing comment on a record.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Baseid`	The identifier of the base containing the record.
`Tablename`	The name of the table containing the record.
`Recordid`	The identifier of the record whose comment to update.
`Rowcommentid`	The identifier of the comment to update.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Text`	The new text content for the comment.

Fields (2)

POST Create field

/meta/bases/{baseId}/tables/{tableId}/fields

Create a new field in a specific table.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Baseid`	The identifier of the base containing the table.
`Tableid`	The identifier of the table where the field should be added.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Description`	A description for the new field.
`Name`	The name of the new field.
`Type`	The data type of the new field, such as 'singleLineText' or 'number'.

GET Update field

Update the properties of an existing field.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

Records (6)

POST Create records

/{baseId}/{tableName}

Create one or more records in a table.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Baseid`	The identifier of the base containing the table.
`Tablename`	The name of the table where records should be created.
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete multiple records

/{baseId}/{tableName}

Delete multiple records from a table at once.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Records`	A comma-separated list of record identifiers to delete.
`Baseid`	The identifier of the base containing the table.
`Tablename`	The name of the table from which to delete records.
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete record

/{baseId}/{tableName}/{recordId}

Delete a single record from a table.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Baseid`	The identifier of the base containing the table.
`Tablename`	The name of the table containing the record.
`Recordid`	The identifier of the record to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get record

/{baseId}/{tableName}/{recordId}

Retrieve the data of a specific record.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Baseid`	The identifier of the base containing the table.
`Tablename`	The name of the table containing the record.
`Recordid`	The identifier of the record to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

GET List records

/{baseId}/{tableName}

Retrieve a list of records from a table.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Baseid`	The identifier of the base containing the table.
`Tablename`	The name of the table whose records to list.
`Response Type`	The response format expected from the API (e.g. application/json).

PATCH Update multiple records

/{baseId}/{tableName}

Update multiple records in a table in a single request.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Baseid`	The identifier of the base containing the table.
`Tablename`	The name of the table containing the records to update.
`Response Type`	The response format expected from the API (e.g. application/json).

Tables (2)

POST Create table

/meta/bases/{baseId}/tables

Create a new table in the specified base. Provide the table name and fields in the request body.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Baseid`	The identifier of the base containing the table.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Description`	A description for the new field.
`Name`	The name of the new field.

PATCH Update table

/meta/bases/{baseId}/tables/{tableName}

Update the properties of an existing table, such as its name or description, in the specified base.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Baseid`	The identifier of the base containing the table.
`Tablename`	The name of the table containing the records to update.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Name`	The name of the new field.