swimlane.core.resources.record module

class swimlane.core.resources.record.Record(app, raw)[source]

Bases: swimlane.core.resources.base.APIResource

A single Swimlane Record instance

id

str – Full Record ID

tracking_id

str – Record tracking ID

created

pendulum.Pendulum – Pendulum datetime for Record created date

modified

pendulum.Pendulum – Pendulum datetime for Record last modified date

is_new

bool – True if Record does not yet exist on server. Other values may be temporarily None if True

get_field(field_name)[source]

Get field instance used to get, set, and serialize internal field value

Returns:Requested field instance
Return type:Field
Raises:UnknownField – Raised if field_name not found in parent App
save()[source]

Persist record changes on Swimlane server

Updates internal raw data with response content from server to guarantee calculated field values match values on server

Raises:ValidationError – If any fields fail validation
validate()[source]

Explicitly validate field data

Notes

Called automatically during save call before sending data to server

Raises:ValidationError – If any fields fail validation
swimlane.core.resources.record.record_factory(app, fields=None)[source]

Return a temporary Record instance to be used for field validation and value parsing

Parameters:
  • app (App) – Target App to create a transient Record instance for
  • fields (dict) – Optional dict of fields and values to set on new Record instance before returning
Returns:

Unsaved Record instance to be used for validation, creation, etc.

Return type:

Record