---
title: Swimlane Record Actions
slug: connectors/swimlane-record-actions
docTags: 
createdAt: 2026-06-09T16:29:44.494Z
---

## Turbine Record Actions

The Turbine Records Actions connector allows you to perform actions on the records in your Turbine instance

## Prerequisites

You need to provide an API token to use this connector.

## Capabilities

This plugin has the capability to search, create, update, and delete records in Turbine.

## Notes

For information on how to write queries, see the documentation for searching in the
[Swimlane Python driver](https://swimlane-python-driver.readthedocs.io/en/stable/examples/resources.html#search-records).

# Configurations

## Add References

Add references to a field in a swimlane record.

### Configuration Parameters

| **Parameter**            | **Description**                             | **Type** | **Required** |
| ------------------------ | ------------------------------------------- | -------- | ------------ |
| tracking\_id             | Tracking ID of the record.                  | string   | Required     |
| app                      | Application of the record.                  | string   | Required     |
| reference\_field         | The name of the field to add references to. | string   | Required     |
| reference\_tracking\_ids | Tracking IDs of references to add.          | array    | Required     |

## Record Actions

Perform actions on Swimlane Records.

### Configuration Parameters

| **Parameter** | **Description**                                                     | **Type** | **Required** |
| ------------- | ------------------------------------------------------------------- | -------- | ------------ |
| host          | The host url for this swimlane instance.                            | string   | Required     |
| username      | The username to authenticate with.                                  | string   | Required     |
| password      | The password to authenticate with.                                  | string   | Required     |
| http\_proxy   | Optional HTTP/HTTPS proxy                                           | string   | Optional     |
| verify\_ssl   | Enable SSL certificate verification. Ignored for non-SSL connection | boolean  | Optional     |

## Create Record

Create Swimlane record.

### Configuration Parameters

| **Parameter**      | **Description**                                                                                         | **Type** | **Required** |
| ------------------ | ------------------------------------------------------------------------------------------------------- | -------- | ------------ |
| record\_data       | A object containing the fields and values to populate in the new record.                                | object   | Required     |
| app                | Application to create the record in.                                                                    | string   | Required     |
| expand\_references | If false, only the Tracking Id of the reference records are returned. If true, all fields are returned. | boolean  | Optional     |

## delete Records

delete Swimlane records.

### Configuration Parameters

| **Parameter** | **Description**                    | **Type** | **Required** |
| ------------- | ---------------------------------- | -------- | ------------ |
| query         | Search Query                       | array    | Required     |
| app           | Application to delete a record in. | string   | Required     |

## Get Record

Get Swimlane record by ID or Tracking ID.

### Configuration Parameters

| **Parameter**      | **Description**                                                                                         | **Type** | **Required** |
| ------------------ | ------------------------------------------------------------------------------------------------------- | -------- | ------------ |
| tracking\_id       | Tracking ID of the record to retrieve.                                                                  | string   | Required     |
| app                | Application to search in.                                                                               | string   | Required     |
| return\_fields     | Only the fields provided will be returned in the record data.                                           | array    | Optional     |
| expand\_references | If false, only the Tracking Id of the reference records are returned. If true, all fields are returned. | boolean  | Optional     |
| reference\_limit   | The max number of references to return.                                                                 | number   | Optional     |

## Patch Record

Patch Swimlane record.

### Configuration Parameters

| **Parameter**  | **Description**                                                                                                                                           | **Type** | **Required** |
| -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------------ |
| app            | Name of the application containing the record to patch.                                                                                                   | string   | Required     |
| tracking\_id   | Tracking ID of the record to patch.                                                                                                                       | string   | Required     |
| patch\_fields  | An object containing all the fields and values to patch. The fields will be overwritten with the new values.                                              | object   | Optional     |
| append\_fields | An object containing all the fields and values to append. The fields will be appended with the new values. The values must match the types of the fields. | object   | Optional     |

## Remove References

Remove references from a field in a swimlane record.

### Configuration Parameters

| **Parameter**            | **Description**                                  | **Type** | **Required** |
| ------------------------ | ------------------------------------------------ | -------- | ------------ |
| tracking\_id             | Tracking ID of the record.                       | string   | Required     |
| app                      | Application of the record.                       | string   | Required     |
| reference\_field         | The name of the field to remove references from. | string   | Required     |
| reference\_tracking\_ids | Tracking IDs of references to remove.            | array    | Required     |

## Search Records

Search Swimlane records.

### Configuration Parameters

| **Parameter**      | **Description**                                                                                         | **Type** | **Required** |
| ------------------ | ------------------------------------------------------------------------------------------------------- | -------- | ------------ |
| query              | Search Query                                                                                            | array    | Optional     |
| limit              | The maximum number of results to return, defaults to 50. A limit of 0 retrieves all results.            | number   | Optional     |
| return\_fields     | Only the fields provided will be returned in the record data.                                           | array    | Optional     |
| app                | Application to search in.                                                                               | string   | Required     |
| expand\_references | If false, only the Tracking Id of the reference records are returned. If true, all fields are returned. | boolean  | Optional     |
| reference\_limit   | The max number of references to return.                                                                 | number   | Optional     |

## Update Record

Update Swimlane record.

### Configuration Parameters

| **Parameter**  | **Description**                                                                                                                                           | **Type** | **Required** |
| -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------------ |
| app            | Name of the application containing the record to update.                                                                                                  | string   | Required     |
| tracking\_id   | Tracking ID of the record to update.                                                                                                                      | string   | Required     |
| update\_fields | An object containing all the fields and values to update. The fields will be overwritten with the new values.                                             | object   | Optional     |
| append\_fields | An object containing all the fields and values to append. The fields will be appended with the new values. The values must match the types of the fields. | object   | Optional     |

## Update Records

Update Swimlane records.

### Configuration Parameters

| **Parameter**  | **Description**                                                                                                                                           | **Type** | **Required** |
| -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------------ |
| query          | Search Query                                                                                                                                              | array    | Required     |
| update\_fields | An object containing all the fields and values to update. The fields will be overwritten with the new values.                                             | object   | Optional     |
| append\_fields | An object containing all the fields and values to append. The fields will be appended with the new values. The values must match the types of the fields. | object   | Optional     |
| app            | Name of the application containing the record to update.                                                                                                  | string   | Required     |

# Response Headers

| **Header**   | **Description**                                       | **Example**                   |
| ------------ | ----------------------------------------------------- | ----------------------------- |
| Content-Type | The media type of the resource                        | application/json              |
| Date         | The date and time at which the message was originated | Thu, 01 Jan 2024 00:00:00 GMT |
