Turbine Record Actions

the turbine records actions connector allows you to perform actions on the records in your turbine instance capabilities this connector has the capability to search, create, update, upsert, and delete records in turbine notes for information on how to write filters, see the documentation for searching in the https //swimlane python driver readthedocs io/en/stable/examples/resources html#search records actions add references add references to a field in a swimlane application record input argument name type required description applicationname string required application name for the record trackingid string required tracking id of the record referencefieldkey string required the key of the field to add references to referencetrackingids array required tracking ids of references to add input example {"applicationname" "example name","trackingid" "string","referencefieldkey" "string","referencetrackingids" \["string"]} add restrictions add restrictions to a swimlane application record input argument name type required description applicationname string required application name for the record trackingid string required tracking id of the record users array optional usernames to restrict the record to groups array optional groups to restrict the record to append boolean optional whether to append or replace restrictions input example {"applicationname" "example name","trackingid" "string","users" \["string"],"groups" \["string"],"append"\ true} create record create a swimlane application record input argument name type required description applicationname string required application name for the record fields object required a object containing the field keys and values to populate in the new record restrictions object optional users and groups to restrict the record to restrictions users array optional usernames to restrict the record to restrictions groups array optional groups to restrict the record to input example {"applicationname" "example name","fields" {},"restrictions" {"users" \["string"],"groups" \["string"]}} output parameter type description tracking id string unique identifier output example {"tracking id" "string"} delete record delete a swimlane application record input argument name type required description applicationname string required application name for the record trackingid string required tracking id of the record input example {"applicationname" "example name","trackingid" "string"} remove references remove references from a field in a swimlane application record input argument name type required description applicationname string required application name for the record trackingid string required tracking id of the record referencefieldkey string required the key of the field to remove references from referencetrackingids array required tracking ids of references to remove input example {"applicationname" "example name","trackingid" "string","referencefieldkey" "string","referencetrackingids" \["string"]} remove restrictions remove restrictions from a swimlane application record input argument name type required description applicationname string required application name for the record trackingid string required tracking id of the record users array optional usernames to remove from the record's restrictions groups array optional groups to remove from the record's restrictions input example {"applicationname" "example name","trackingid" "string","users" \["string"],"groups" \["string"]} search records search swimlane application records input argument name type required description applicationname string required application name for the record filters array optional search filters filtertype string optional select whether this is an "and" or an "or" filter returnfields array optional only the fields provided will be returned in the record data limit number optional the maximum number of results to return, defaults to 1000 input example {"applicationname" "example name","filters" \[],"filtertype" "string","returnfields" \["string"],"limit" 123} output parameter type description records array output field records records tracking id string unique identifier count number count value limit number output field limit iscountlimited boolean output field iscountlimited output example {"records" \[],"count" 123,"limit" 123,"iscountlimited"\ true} update record update a swimlane application record input argument name type required description applicationname string required application name for the record trackingid string required tracking id of the record to update patchvalues object optional an object containing all the field keys and values to update the fields will be overwritten with the new values appendvalues object optional an object containing all the field keys and values to append the fields will be appended with the new values the values must match the types of the fields input example {"applicationname" "example name","trackingid" "string","patchvalues" {},"appendvalues" {}} output parameter type description tracking id string unique identifier output example {"tracking id" "string"} update/create record updates or creates a swimlane application record based on a key field input argument name type required description applicationname string required application name for the record keyfieldkey string required key of the field to use as a unique identifier keyfieldvalue string required value of the key field patchvalues object optional an object containing all the field keys and values to update the fields will be overwritten with the new values appendvalues object optional an object containing all the field keys and values to append the fields will be appended with the new values the values must match the types of the fields input example {"applicationname" "example name","keyfieldkey" "string","keyfieldvalue" "string","patchvalues" {},"appendvalues" {}} output parameter type description tracking id string unique identifier output example {"tracking id" "string"} 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