Swimlane Record Actions
18 min
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 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 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