swimlane.core.resources.app module

class swimlane.core.resources.app.App(*args, **kwargs)

Bases: APIResource

A single App record instance

Used lookup field definitions and retrieve/create child Record instances

name

App name

Type:

str

acronym

App acronym

Type:

str

description

App description

Type:

str

id

Full App ID

Type:

str

tracking_id

App tracking ID

Type:

str

records

RecordAdapter configured for current App

Type:

RecordAdapter

reports

ReportAdapter configured for current App

Type:

ReportAdapter

get_cache_index_keys()

Return all fields available when retrieving apps

get_field_definition_by_id(field_id)

Get JSON field definition for field matching provided id

Parameters:

field_id (str) – Target field ID to get definition for

Raises:

swimlane.exceptions.UnknownField – Raised when given a field ID not found in App

Returns:

Field metadata definition

Return type:

dict

get_field_definition_by_name(field_name)

Get JSON field definition for field matching provided name or key

Changed in version 4.1.0: Added support for field keys

Parameters:

field_name (str) – Target field name or key to get definition for

Raises:

swimlane.exceptions.UnknownField – Raised when given a field name not found in App

Returns:

Field metadata definition

Return type:

dict

resolve_field_name(field_key)

Return the field name matching the given key or None. Searches field keys first, falls back to field names