swimlane.core.resources.app module

class swimlane.core.resources.app.App(swimlane, raw)

Bases: swimlane.core.resources.base.APIResource

A single App record instance

Used lookup field definitions and retrieve/create child Record instances

name

str – App name

acronym

str – App acronym

description

str – App description

id

str – Full App ID

tracking_id

str – App tracking ID

records

RecordAdapter – RecordAdapter configured for current App

reports

ReportAdapter – ReportAdapter configured for current App

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

Parameters:field_name (str) – Target field name 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