Resources

See swimlane.core.resources for full API docs on all resources

App

App instances represent apps available on Swimlane server, and provide methods to retrieve and create child Records

Retrieve apps using the apps adapter available on the swimlane.Swimlane client

Retrieve Records

Records can be retrieved by full IDs. Only records in the source app are returned, IDs matching records from other apps will fail to be retrieved.

record = app.records.get(id='58f...387')

Search Records

Searching is done using the app.records adapter, and uses temporary Report instances to handle paginated search results and record retrieval on-demand.

Search is done by providing multiple tuples that are applied as filters and AND’ed together on the underlying report.

Note

Reports are normally iterated and paginated over in batches. Using the app.records.search method loads all report results into a list before returning, which can be a heavy operation.

A default limit is placed on reports to prevent this from happening accidentally, use the limit parameter to override the default limit on a search.

records = app.records.search(
    ('Field Name', 'equals', 'value'),
    ('Other Field', 'doesNotEqual', 'value'),
    limit=20
)

Create New Record

Record creation is done through the app.records adapter, and adheres to all field validation as documented below

The newly created record is returned from the create create call after first being persisted on the server

new_record = app.records.create(**{
    'Text Field': 'Field Value',
    'Numeric Field': 50,
    ...
})

Batch Record Creation

Creating multiple records at once can also done withe the app.records adapter using only a single request.

Any records not passing validation will cause the entire operation to fail.

records = app.records.create_batch(
    {'Text Field': 'Value 1', 'Numeric Field': 10, ...},
    {'Text Field': 'Value 2', 'Numeric Field': 20, ...},
    ...
)

Record

Record instances represent individual records inside a corresponding app on Swimlane server.

They provide the ability to interact with field data similar to how it’s done in the Swimlane UI, and handle translating and validating field types using various Field classes under the hood.

Accessing Field Values

Fields are accessed as keys by their readable field names as seen in the UI. Field names are case and whitespace sensitive, and are unique within an individual app.

Assuming a record from an app with a text field called “Text” with a value of “Some Example Text”, accessing the field value is done as follows:

assert record['Text'] == 'Some Example Text'

Any fields without a value default to None.

Setting Field Values

Setting field values works the same as accessing values.

record['Text'] = 'New Text'

assert record['Text'] == 'New Text'

Clearing Field Values

Clearing field values can be done in one of two way. The following examples are identical, and simply clear the field value, setting it back to None internally.

# Delete the field
del record['Text']

# Or set directly to None
record['Text'] = None

Field Validation

Most field types enforce a certain type during the set operation, and will raise a swimlane.exceptions.ValidationError on any kind of failure, whether it’s an invalid value, incorrect type, etc. and will contain information about why it was unable to validate the new value.

try:
    record['Numeric'] = 'String'
except ValidationError as error:
    print(error)

See individual field examples for more specifics on each field type and their usage.

Saving Changes

All changes to a record are only done locally until explicitly persisted to the server with save()

record['Text'] = 'Some New Text'
record.save()

Field Iteration

Records can be iterated over like dict.items(), yielding (field_name, field_value) tuples

for field_name, field_value in record:
    assert record[field_name] == field_value

Unknown Fields

Attempting to access a field not available on a record’s parent app will raise swimlane.exceptions.UnknownField with the invalid field name, as well as potential similar field names in case of a possible typo.

try:
    record['Rext'] = 'New Text'
except UnknownField as error:
    print(error)

UserGroup

Handling Users, Groups, and UserGroups

Users and Groups both extend from the base UserGroup class. Most values returned from the server are of the base UserGroup type, but can be replaced or set by the more specific classes.

# User / Group fields return UserGroup instances when accessed
assert type(record['Created By']) is UserGroup

# But can be set to the more specific User / Group types directly
record['User'] = swimlane.user
record['Group'] = swimlane.groups.get(name='Everyone')

Comparisons

Users and Groups and be directly compared to the base UserGroup class, and will be considered equal if the two objects represent the same entity

assert record['Created By'] == swimlane.user

assert record['Group'] == swimlane.groups.get(name='Everyone')