﻿The Swimlane platform provides a REST API with numerous endpoints that allow developers to harness and extend the platform's automation and orchestration power. As a developer, you can use any programming tool with an HTTP library or capability. You can also use the 

 documentation, which is a client library that can streamline your efforts to implement solutions.

In general, when authoring Python scripts for Swimlane, follow these guidelines:

This is an example of a Swimlane Python Driver script for connecting to Swimlane and creating a new record in a specified application:

from swimlane import Swimlane # Connect Swimlane client host = 'HOST' base_url = 'https://{0}'.format(host) swimlane = Swimlane(base_url, 'USER', 'PASSWORD', verify_ssl=False) # Retrieve App by name app = swimlane.apps.get(name='Event') # Create new Record new_record = app.records.create(**{ 'Event Name': 'demo security event 1', 'Event Message': 'this event is for demonstration purposes' })

from swimlane import Swimlane # Connect Swimlane client host = 'HOST' base_url = 'https://{0}'.format(host) swimlane = Swimlane(base_url, 'USERNAME', 'PASSWORD', verify_ssl=False) # Retrieve App by name app = swimlane.apps.get(name='Event') # Fetch existing record record = app.records.get(tracking_id='EV1-4') # Modify record record['Event Message'] = 'I\'ve been updated!!!' # Persist the modification record.patch()

The scripts above highlight the efficiency of scripting with Swimlane Python Driver. The examples that follow are example scripts in REST API.

Here's a sample REST API script for connecting to Swimlane and creating a new record in a specified application:

import requests from urlparse import urljoin s = requests.Session() # Authenticate host = 'HOST' base_url = 'https://{0}'.format(host) creds = {'userName': 'USERNAME', 'password': 'PASSWORD'} resp = s.post(urljoin(base_url, 'api/user/login'), json=creds) json_content = resp.json() token = json_content.pop('token', None) headers = { 'Authorization': 'Bearer {}'.format(token) } s.headers.update(headers) # Retrieve the chosen application resp = s.get(urljoin(base_url, 'api/app')) apps = resp.json() app_obj = None for app in apps: if app['name'] == 'Event': app_obj = app break # Create a new record in the chosen application. First find pertinent field ID values in order to make correct field value assignments. name_field_id = None msg_field_id = None for field in app_obj['fields']: if field['name'] == 'Event Name': name_field_id = field['id'] if field['name'] == 'Event Message': msg_field_id = field['id'] record = { 'applicationId': app_obj['id'], 'values': { '$type': 'System.Collections.Generic.Dictionary`2[[System.String, mscorlib],[System.Object, mscorlib]], mscorlib', name_field_id: 'demo security event 1', msg_field_id: 'this event is for demonstration purposes' } } result = s.post(urljoin(base_url, 'api/app/' + app_obj['id'] + '/record'), json=record) print result

Here is a sample script for fetching an existing record, modifying it, and persisting the changes:

import requests from urlparse import urljoin import json s = requests.Session() # Authenticate host = 'HOST' base_url = 'https://{0}'.format(host) creds = {'userName': 'USER', 'password': 'PASSWORD'} resp = s.post(urljoin(base_url, 'api/user/login'), json=creds) json_content = resp.json() token = json_content.pop('token', None) headers = { 'Authorization': 'Bearer {}'.format(token) } s.headers.update(headers) # Retrieve the chosen application resp = s.get(urljoin(base_url, 'api/app')) apps = resp.json() app_obj = None for app in apps: if app['name'] == 'Event': app_obj = app break # Find chosen field ID msg_field_id = None for field in app_obj['fields']: if field['name'] == 'Event Message': msg_field_id = field['id'] break # Retrieve an existing record result = s.get(urljoin(base_url, 'api/app/' + app_obj['id'] + '/record/tracking/EV1-1')) #print result rec = result.json() #print json.dumps(rec, sort_keys=True, indent=4, separators=(",", ": ")) # Update the record rec['values'][msg_field_id] = 'I\'ve been updated!!!' # Persist the alteration to the record result = s.put(urljoin(base_url, 'api/app/' + app_obj['id'] + '/record/' + rec['id']), json=rec) print result

Here is the same script made more optimal by using HTTP PATCH rather than HTTP PUT to avoid REST API-centric race conditions that can arise when two scripts are attempting to operate on the same record within the same span of time:

 The use of PATCH reduces the chances of harmful, colliding alterations to the record.

import requests from urlparse import urljoin import json s = requests.Session() # Authenticate host = 'HOST' base_url = 'https://{0}'.format(host) creds = {'userName': 'USER', 'password': 'PASSWORD'} resp = s.post(urljoin(base_url, 'api/user/login'), json=creds) json_content = resp.json() token = json_content.pop('token', None) headers = { 'Authorization': 'Bearer {}'.format(token) } s.headers.update(headers) # Retrieve the chosen application resp = s.get(urljoin(base_url, 'api/app')) apps = resp.json() app_obj = None for app in apps: if app['name'] == 'Event': app_obj = app break # Find chosen field IDs name_field_id = None msg_field_id = None tracking_field_id = None for field in app_obj['fields']: if field['name'] == 'Event Name': name_field_id = field['id'] if field['name'] == 'Event Message': msg_field_id = field['id'] if field['name'] == 'Tracking Id': tracking_field_id = field['id'] # Retrieve an existing record result = s.get(urljoin(base_url, 'api/app/' + app_obj['id'] + '/record/tracking/EV1-1')) print result rec = result.json() #print json.dumps(rec, sort_keys=True, indent=4, separators=(",", ": ")) # Update the record rec['values'][msg_field_id] = 'I\'ve been updated!!!' rec['values'].pop(tracking_field_id, None) # The PATCH endpoint will throw error with a 400 response if the Tracking Id is present as a field value. rec['values'].pop(name_field_id, None) #print json.dumps(rec, sort_keys=True, indent=4, separators=(",", ": ")) # Persist the alteration to the record result = s.patch(urljoin(base_url, 'api/app/' + app_obj['id'] + '/record/' + rec['id']), json=rec) print result # Print result.text if you want to see the error message that accompanies an HTTP 400 response.

REST API and the Swimlane Python Driver Library

Rest API

test12

sdfdssdfsdfsdfsdfdsfsdf

edfsad

dsfsdfsdf

test

specific

var_miha

new_var_2

new_mih_var

mih_var

testheight

available

testulet

testvar

This is a plain text that will be inserted in an expandable heading for using this raw as an exampl

altscenario

This is a plain text that will be inserted in an expandable heading for using this raw as an example

scenario

exemplu

variabila

Archbee

text

refresh_token

YourBank

MyBank

variable_test_video

variable123

silviu

Bogdan_test

ferwhethgte

target1

google

support

product_name

productName1

companyLegalName

programName

customerName1

productName

Product_Name

Test

SEFAS

uptempo

customerName

testName

name1

customername

apilink1-getallmethod

variable_one

capitalize

company_name_adobe

jama_2

jama_1

domain

email

product

Glossary lets you define every tricky term, then gives them a sneak peek explanation on hover... Just like I'm doing with this text right here!

Glossary_feature

Google

aaaa

insitutionAdress

dasdas666

aa112

asdasdas

asdasd

What

New_reusable

test_var2

test_var

Read-Only Field Behavior

Swimlane (10x) User Guide

Welcome to Swimlane

Customize Your User Profile

Key Terms and Concepts

Navigation Basics

Run Swimlane on AWS

Introduction

Build an Application

Create the Initial Workflow

Customize Record Views

Add More Workflow Detail

Test Record Automation

Create a Python Integration Task

Test the Latest Automation in Records

Learn the Basics

Create an IMAP Email Asset

Create a Suspicious Emails Application

Create a Suspicious Emails Task

 Verify That Your Task Works

Create a VirusTotal Asset and Task

Add Parsing Detail to the Suspicious Emails Task

Add Automation to the Suspicious Emails Application

Test Your VirusTotal Automation

Automate a VirusTotal Analysis

Getting Started Guide

Navigate Workspaces and Dashboards

Create or Edit User Dashboards

Set Dashboard Permissions

Create or Edit Cards

Workspaces and Dashboards

Customize the List of Records

Search Record Data

Lock Records

Restrict Records

Coedit Records

Manage Server Conflicts in Records

Lookup and Create References within Records

Modify a Record

Bulk Modify Records

Share Records

Records and Workflow

View Record History

Correlate Records

Export Record Data

Import Record Data

Application Records

Keyword Search and Filter

Create and Save Reports

Share Reports by Schedule

Share Reports by Email

Download Reports

Share Reports

Chart Types

Measures and Dimensions

Chart Options

Colors

Sorting

Drill-in

Charts

Reports

Manage Applications and Applets

Define the Foundation

Create the Layout

Select Fields and Assign Field Properties

Add Applets

Calculation Builder

View Revision History

Export Templates

Application Builder

Data Retention

Build an Applet

Applets and Tasks

Applets and Workflow

Export Applets

Import Applets

Applet Builder

Import Swimlane Solution Packages

Export Swimlane Solution Packages

Swimlane Support Packages

Conditions

Repeats

Create and Update Workflow

Actions

Create Export Templates from Workflow

Workflow

Widgets Editor

Record Widgets

Report Widgets

Widget Code Structure

Widgets

Applications and Applets

Swimlane Hero AI Help Chatbot

Crafted AI Prompts

Hero AI

Create or Edit a Task

Configure Task Input

Python Task Logging

Review, Discover, and Add Output Parameters

Map Output for Creating or Updating Records

Map Other Types of Output

JSONpath in Python Tasks

Configure Task Output

Upload and Manage Plugins

Create or Edit an Asset

Create or Edit the Key Store

Upload Scripts and Tasks

Install or Upload Python Packages

Integrations

Create or Edit Workspaces

Create or Edit Dashboards

Edit Reports

Workspace Management

Role Permissions

User Permissions

Group Permissions

Permissions