Object Type Mappings

Performance Implications

fborm.objects Module Documentation

fborm.objects.fbError = {'apiKey': fborm.types.<fbcastfunc>, '...': ...}

Key (Value):

• code (fborm.types.fbattr) –
• sError (fborm.types.fbself) –

fborm.objects.fbFilter = {'apiKey': fborm.types.<fbcastfunc>, '...': ...}

Key (Value):

• sFilter (fborm.types.fbattr) – Attribute of type fborm.types.fbstring which may either be the name of one of the special built-in filters or it will be the filter id seen in the URL. This is the value to use with the fborm.commands.setCurrentFilter() command.
• sFilterName (fborm.types.fbself) – Name of the filer which is dsiplayed in the UI.
• status (fborm.types.fbattr) – Attribute of type fborm.types.fbstring which will have the value of "current" or it will be None.
• type (fborm.types.fbattr) – Attribute of type fborm.types.fbstring which will have the value of "builtin", "saved", or "shared".

The FogBugz API call listFilters has output that is different from all the other API calls. The data returned is not parameterized into tags. Instead the data that is useful are attributes on teh parent tag. This means we need to do some special processing to extract the data in a meaningful way. Here is an example return by the API:

<filters>
    <filter type="builtin" sFilter="ez">My Cases</filter>
    <filter type="builtin" sFilter="inbox">Inbox</filter>
    <filter type="shared" sFilter="7"><![CDATA[Active Bugs Outline]]></filter>
    <filter type="shared" sFilter="9"><![CDATA[Active Requests Outline]]></filter>
    <filter type="shared" sFilter="13"><![CDATA[All Active]]></filter>
</filters>

The XML attribute sFilter is what needs to be passed as an argument to The FogBugz API call setCurrentFilter. To simplify and make the API uniform the FogBugz-ORM wrapper API converts this into a standardized structure. The FogBugz ORM wrapper API call fborm.commands.setCurrentFilter() has also been extended to support a number of inputs, including this structure.

See fborm.commands.listFilters() , fborm.commands.setCurrentFilter() and FogBugz API - Filters for more information.

fborm.objects.fbTag = {'apiKey': fborm.types.<fbcastfunc>, '...': ...}

Key (Value):

• cTagUses (fborm.types.fbint) –
• ixTag (fborm.types.fbint) –
• sTag (fborm.types.fbstring) –

fborm.objects.fbPerson = {'apiKey': fborm.types.<fbcastfunc>, '...': ...}

Key (Value):

• dtLastActivity (fborm.types.fbdatetime) –
• fAdministrator (fborm.types.fbbool) –
• fCommunity (fborm.types.fbbool) –
• fDeleted (fborm.types.fbbool) –
• fNotify (fborm.types.fbbool) –
• fPaletteExpanded (fborm.types.fbbool) –
• fRecurseBugChildren (fborm.types.fbbool) –
• fVirtual (fborm.types.fbbool) –
• ixBugWorkingOn (fborm.types.fbint) –
• ixPerson (fborm.types.fbint) –
• sEmail (fborm.types.fbstring) –
• sFrom (fborm.types.fbstring) –
• sFullName (fborm.types.fbstring) –
• sHomepage (fborm.types.fbstring) –
• sLDAPUid (fborm.types.fbstring) –
• sLanguage (fborm.types.fbstring) –
• sLocale (fborm.types.fbstring) –
• sPhone (fborm.types.fbstring) –
• sTimeZoneKey (fborm.types.fbstring) –

fborm.objects.fbProject = {'apiKey': fborm.types.<fbcastfunc>, '...': ...}

Key (Value):

• fDeleted (fborm.types.fbbool) –
• fInbox (fborm.types.fbbool) –
• ixPersonOwner (fborm.types.fbint) –
• ixProject (fborm.types.fbint) –
• ixWorkflow (fborm.types.fbint) –
• sEmail (fborm.types.fbstring) –
• sPersonOwner (fborm.types.fbstring) –
• sPhone (fborm.types.fbstring) –
• sProject (fborm.types.fbstring) –

fborm.objects.fbCategory = {'apiKey': fborm.types.<fbcastfunc>, '...': ...}

Key (Value):

• fDeleted (fborm.types.fbbool) –
• fIsScheduleItem (fborm.types.fbbool) –
• iOrder (fborm.types.fbint) –
• ixAttachmentIcon (fborm.types.fbint) –
• ixCategory (fborm.types.fbint) –
• ixStatusDefault (fborm.types.fbint) –
• ixStatusDefaultActive (fborm.types.fbint) –
• nIconType (fborm.types.fbint) –
• sCategory (fborm.types.fbstring) –
• sPlural (fborm.types.fbstring) –

fborm.objects.fbPriority = {'apiKey': fborm.types.<fbcastfunc>, '...': ...}

Key (Value):

• fDefault (fborm.types.fbbool) –
• ixCategory (fborm.types.fbint) –
• sPriority (fborm.types.fbstring) –

fborm.objects.fbStatus = {'apiKey': fborm.types.<fbcastfunc>, '...': ...}

Key (Value):

• fDeleted (fborm.types.fbbool) –
• fDuplicate (fborm.types.fbbool) –
• fResolved (fborm.types.fbbool) –
• fWorkDone (fborm.types.fbbool) –
• iOrder (fborm.types.fbint) –
• ixCategory (fborm.types.fbint) –
• ixStatus (fborm.types.fbint) –
• sStatus (fborm.types.fbstring) –

fborm.objects.fbArea = {'apiKey': fborm.types.<fbcastfunc>, '...': ...}

Key (Value):

• cDoc (fborm.types.fbint) –
• ixArea (fborm.types.fbint) –
• ixPersonOwner (fborm.types.fbint) –
• ixProject (fborm.types.fbint) –
• nType (fborm.types.fbint) –
• sArea (fborm.types.fbstring) –
• sPersonOwner (fborm.types.fbstring) –
• sProject (fborm.types.fbstring) –

fborm.objects.fbAttachment = {'apiKey': fborm.types.<fbcastfunc>, '...': ...}

Key (Value):

• sFilename (fborm.types.fbstring) –
• sURL (fborm.types.fbstring) –

fborm.objects.fbstring_fEmail = <functools.partial object at 0x100684d60>

fborm.objects.fbBugMiniEvent = {'apiKey': fborm.types.<fbcastfunc>, '...': ...}

Key (Value):

• dt (fborm.types.fbdatetime) –
• evt (fborm.types.fbint) –
• evtDescription (fborm.types.fbstring) –
• fEmail (fborm.types.fbbool) –
• fExternal (fborm.types.fbbool) –
• fHTML (fborm.types.fbbool) –
• ixBug (fborm.types.fbattr) –
• ixBugEvent (fborm.types.fbint) –
• ixPerson (fborm.types.fbint) –
• ixPersonAssignedTo (fborm.types.fbint) –
• rgAttachments (fborm.types.fblistof) –
• sBCC (fborm.types.fbconditional) –
• sBody (fborm.types.fbconditional) –
• sBodyHTML (fborm.types.fbconditional) –
• sChanges (fborm.types.fbstring) –
• sDate (fborm.types.fbconditional) –
• sFormat (fborm.types.fbstring) –
• sFrom (fborm.types.fbconditional) –
• sPerson (fborm.types.fbstring) –
• sReplyTo (fborm.types.fbconditional) –
• sSubject (fborm.types.fbconditional) –
• sTo (fborm.types.fbconditional) –
• sVerb (fborm.types.fbstring) –

fborm.objects.fbBugEvent = {'apiKey': fborm.types.<fbcastfunc>, '...': ...}

Key (Value):

• dt (fborm.types.fbdatetime) –
• evt (fborm.types.fbint) –
• evtDescription (fborm.types.fbstring) –
• fEmail (fborm.types.fbbool) –
• fExternal (fborm.types.fbbool) –
• fHTML (fborm.types.fbbool) –
• ixBug (fborm.types.fbattr) –
• ixBugEvent (fborm.types.fbint) –
• ixPerson (fborm.types.fbint) –
• ixPersonAssignedTo (fborm.types.fbint) –
• rgAttachments (fborm.types.fblistof) –
• s (fborm.types.fbstring) –
• sBCC (fborm.types.fbconditional) –
• sBody (fborm.types.fbconditional) –
• sBodyHTML (fborm.types.fbconditional) –
• sChanges (fborm.types.fbstring) –
• sDate (fborm.types.fbconditional) –
• sFormat (fborm.types.fbstring) –
• sFrom (fborm.types.fbconditional) –
• sHTML (fborm.types.fbstring) –
• sPerson (fborm.types.fbstring) –
• sReplyTo (fborm.types.fbconditional) –
• sSubject (fborm.types.fbconditional) –
• sTo (fborm.types.fbconditional) –
• sVerb (fborm.types.fbstring) –

fborm.objects.fbBug_ixBug = {'apiKey': fborm.types.<fbcastfunc>, '...': ...}

Key (Value):ixBug (fborm.types.fbint) –

very common for use with adding a new case

fborm.objects.fbBug = {'apiKey': fborm.types.<fbcastfunc>, '...': ...}

Key (Value):

• ixArea (fborm.types.fbint) –
• ixBug (fborm.types.fbint) –
• ixBugChildren (fborm.types.fbixBugChildren) –
• ixBugParent (fborm.types.fbint) –
• ixCategory (fborm.types.fbint) –
• ixPersonAssignedTo (fborm.types.fbint) –
• ixPriority (fborm.types.fbint) –
• ixProject (fborm.types.fbint) –
• sArea (fborm.types.fbstring) –
• sCategory (fborm.types.fbstring) –
• sPersonAssignedTo (fborm.types.fbstring) –
• sPriority (fborm.types.fbstring) –
• sProject (fborm.types.fbstring) –
• sTitle (fborm.types.fbstring) –

fborm.objects.fbBug_withLatestEvent = {'apiKey': fborm.types.<fbcastfunc>, '...': ...}

Key (Value):

• ixArea (fborm.types.fbint) –
• ixBug (fborm.types.fbint) –
• ixBugChildren (fborm.types.fbixBugChildren) –
• ixBugParent (fborm.types.fbint) –
• ixCategory (fborm.types.fbint) –
• ixPersonAssignedTo (fborm.types.fbint) –
• ixPriority (fborm.types.fbint) –
• ixProject (fborm.types.fbint) –
• latestEvent (fborm.types.fblatestevent) –
• sArea (fborm.types.fbstring) –
• sCategory (fborm.types.fbstring) –
• sPersonAssignedTo (fborm.types.fbstring) –
• sPriority (fborm.types.fbstring) –
• sProject (fborm.types.fbstring) –
• sTitle (fborm.types.fbstring) –

fborm.objects.fbBug_withEvents = {'apiKey': fborm.types.<fbcastfunc>, '...': ...}

Key (Value):

• events (fborm.types.fbevents) –
• ixArea (fborm.types.fbint) –
• ixBug (fborm.types.fbint) –
• ixBugChildren (fborm.types.fbixBugChildren) –
• ixBugParent (fborm.types.fbint) –
• ixCategory (fborm.types.fbint) –
• ixPersonAssignedTo (fborm.types.fbint) –
• ixPriority (fborm.types.fbint) –
• ixProject (fborm.types.fbint) –
• sArea (fborm.types.fbstring) –
• sCategory (fborm.types.fbstring) –
• sPersonAssignedTo (fborm.types.fbstring) –
• sPriority (fborm.types.fbstring) –
• sProject (fborm.types.fbstring) –
• sTitle (fborm.types.fbstring) –

fborm.objects.fbBug_withMiniEvents = {'apiKey': fborm.types.<fbcastfunc>, '...': ...}

Key (Value):

• ixArea (fborm.types.fbint) –
• ixBug (fborm.types.fbint) –
• ixBugChildren (fborm.types.fbixBugChildren) –
• ixBugParent (fborm.types.fbint) –
• ixCategory (fborm.types.fbint) –
• ixPersonAssignedTo (fborm.types.fbint) –
• ixPriority (fborm.types.fbint) –
• ixProject (fborm.types.fbint) –
• minievents (fborm.types.fbminievents) –
• sArea (fborm.types.fbstring) –
• sCategory (fborm.types.fbstring) –
• sPersonAssignedTo (fborm.types.fbstring) –
• sPriority (fborm.types.fbstring) –
• sProject (fborm.types.fbstring) –
• sTitle (fborm.types.fbstring) –

fborm.objects.fbFixFor = {'apiKey': fborm.types.<fbcastfunc>, '...': ...}

Key (Value):

• dt (fborm.types.fbcol) –
• dtStart (fborm.types.fbdatetime) –
• fDeleted (fborm.types.fbcol) –
• fReallyDeleted (fborm.types.fbbool) –
• ixFixFor (fborm.types.fbint) –
• ixProject (fborm.types.fbint) –
• sFixfor (fborm.types.fbstring) –
• sProject (fborm.types.fbstring) –
• sStartNote (fborm.types.fbstring) –
• setixForForDependency (fborm.types.fbcol) –

fborm.objects.fbMilestone = {'apiKey': fborm.types.<fbcastfunc>, '...': ...}

alias of fborm.objects.fbFixFor