The Basics

cmd=listFixFors

Parameters
Optionally takes ixProject, ixFixFor (will include this milestone even if it is unassignable), fIncludeDeleted (set to 1 to include inactive milestones), and fIncludeReallyDeleted (set to 1 to include completely deleted milestones.  Really.)
Example
https://kakapo.fogbugz.com/api.asp?cmd=listFixFors&token=04t6193822pekbba09nt74ninuihk2
Returns
Data for selected milestones.  
cmd=viewFixFor

Parameters
Takes either ixFixFor or sFixFor and ixProject.
Example
https://kakapo.fogbugz.com/api.asp?cmd=viewFixFor&ixFixFor=6&token=04t6193822pekbba09nt74ninuihk2
Returns
The data for the selected milestone.
cmd=newFixFor

Parameters
Requires ixProject and sFixFor (the title of the new milestone).  Optionally takes dtRelease, dtStart, sStartNote, and fAssignable.
Example
https://kakapo.fogbugz.com/api.asp?cmd=newFixFor&ixProject=6&sFixFor=Version%202.9&token=04t6193822pekbba09nt74ninuihk2 
Returns
Data for the newly created milestone.
cmd=editFixFor

Parameters
Requires ixFixFor and sFixFor (the title of the new milestone).  Optionally takes dtRelease, dtStart, sStartNote, and fAssignable.
Example
https://kakapo.fogbugz.com/api.asp?cmd=editFixFor&ixFixFor=4&sFixFor=Version%203.9&sStartNote=Security%20patch.&token=04t6193822pekbba09nt74ninuihk2 
Returns
The case number of the edited milesone.
cmd=addFixForDependency

Parameters
Requires ixFixFor and ixFixForDependsOn.
Example
https://kakapo.fogbugz.com/api.asp?cmd=addFixForDependency&ixFixFor=10&ixFixForDependsOn=11&token=04t6193822pekbba09nt74ninuihk2 
Returns
Empty response (</response>).
cmd=addFixForDependency

Parameters
Requires ixFixFor and ixFixForDependsOn.
Example
https://kakapo.fogbugz.com/api.asp?cmd=addFixForDependency&ixFixFor=10&ixFixForDependsOn=11&token=04t6193822pekbba09nt74ninuihk2 
Returns
Empty response (</response>).
cmd=deleteFixForDependency

Parameters
Requires ixFixFor and ixFixForDependsOn.
Example
https://kakapo.fogbugz.com/api.asp?cmd=deleteFixForDependency&ixFixFor=10&ixFixForDependsOn=11&token=04t6193822pekbba09nt74ninuihk2 
Returns
Empty response (</response>).

Listing Milestones (cmd=listMilestones)

URL
https://kakapo.fogbugz.com/api.asp?cmd=listFixFors&token=04t6193822pekbba09nt74ninuihk2
fogbugz.py
fb.listFixFors()

Parameters

  • ixProject – optional
    • Only list milestones for this project, default behavior is to list all milestones
  • ixFixFor – optional
    • If listing all milestones will include this milestone even if it’s unassignable (i.e. inactive),
  • fIncludeDeleted=0 – default 0
    • Set to 1 to include inactive milestones (i.e. those that are marked unassignable)
  • fIncludeReallyDeleted=0 – default 0
    • Set to 1 to include completely deleted milestones (i.e. no longer viewable or assignable)

Successful Response

For the sake of space, only one milestone is being included below. The listFixFors command returns all milestones that match the given parameters.

XML
<response>
  <fixfors>
    <fixfor>
      <ixFixFor>9</ixFixFor>
      <sFixFor>
        <![CDATA[ Version 1.0 ]]>
      </sFixFor>
      <fDeleted>false</fDeleted>
      <dt>2016-09-14T22:00:00Z</dt>
      <dtStart>2016-04-03T22:00:00Z</dtStart>
      <sStartNote/>
      <ixProject>10</ixProject>
      <sProject>
        <![CDATA[ Kakapo ]]>
      </sProject>
      <setixFixForDependency/>
      <fReallyDeleted>false</fReallyDeleted>
    </fixfor>
  </fixfors>
</response>

View a Single Milestone (cmd=viewFixFor)

URL
https://kakapo.fogbugz.com/api.asp?cmd=viewFixFor&ixFixFor=6&token=04t6193822pekbba09nt74ninuihk2
fogbugz.py
fb.viewFixFor(ixFixFor=6)

Parameters

Takes either ixFixFor or sFixFor and ixProject.

Possible Responses

Successful Response

For the sake of space, only one milestone is being included below. The listFixFors command returns all milestones that match the given parameters.

XML
<response>
  <fixfor>
    <ixFixFor>6</ixFixFor>
    <sFixFor>
      <![CDATA[ Version 2.0 ]]>
    </sFixFor>
    <fInactive>false</fInactive>
    <dt>2016-04-20T04:00:00Z</dt>
    <ixProject>1</ixProject>
    <dtStart>2016-02-15T05:00:00Z</dtStart>
    <sStartNote/>
    <setixFixForDependency>
    <ixFixFor>2</ixFixFor>
    </setixFixForDependency>
  </fixfor>
</response>
No Such Milestone
XML
</response>

Creating a New Milestone (cmd=newFixFor)

URL
https://kakapo.fogbugz.com/api.asp?cmd=newFixFor&ixProject=6&sFixFor=Version%202.9&token=04t6193822pekbba09nt74ninuihk2 
fogbugz.py
fb.newFixFor(ixProject=6,
				sFixFor="Version 1.9")

Parameters

  • ixProject – required
    • Set ixProject to -1 to create a global milestone
  • sFixFor – required
    • The title of the new milestone
  • dtRelease – optional
  • dtStart – optional
  • sStartNote – optional
  • fAssignable – optional

Possible Responses

Successful Response
XML
<response>
  <fixfor>
    <ixFixFor>13</ixFixFor>
    <sFixFor>
      <![CDATA[ Version 2.9 ]]>
    </sFixFor>
    <fInactive>true</fInactive>
    <dt/>
    <ixProject>2</ixProject>
    <dtStart/>
    <sStartNote/>
    <setixFixForDependency/>
  </fixfor>
</response>
No Such Project
XML
<response>
  <error code="17">
    <![CDATA[ No such project ]]>
  </error>
</response>
Duplicate sFixFor
XML
<response>
  <error code="20">
    <![CDATA[
      A milestone with this name already exists in this project
    ]]>
  </error>
</response>

Editing an Existing Milestone (cmd=editFixFor)

Note that any parameters omitted from the call will take default values, not the existing values of the milestone being edited. To be certain that you only change the value(s) intended, you can precede the call to editFixFor with viewFixFor. The dates for dtRelease and stStart are interpreted to be in your site’s timezone.

URL
https://kakapo.fogbugz.com/api.asp?cmd=editFixFor&ixFixFor=4&sFixFor=Version%203.9&sStartNote=Security%20patch.&token=04t6193822pekbba09nt74ninuihk2 
fogbugz.py
fb.edit(ixFixFor=4,
        sFixFor="Version 2.0",
		sStartNote="Security patch."
        )

Parameters

  • ixFixFor – required
  • sFixFor – required
  • dtRelease – default: NULL
  • dtStart – default: NULL
  • sStartNote – default: NULL
  • fAssignable – default: False

Possible Responses

Successful Response
XML
<response>
  <fixfor>
    <ixFixFor>4</ixFixFor>
    <sFixFor>
      <![CDATA[ Version 3.9 ]]>
    </sFixFor>
    <fInactive>true</fInactive>
    <dt/>
    <ixProject>-1</ixProject>
    <dtStart/>
    <sStartNote/>
    <setixFixForDependency/>
  </fixfor>
</response>
No sFixFor Supplied
XML
<response>
  <error code="20">
    <![CDATA[ Enter a name or version number for this milestone ]]>
  </error>
</response>
No Such ixFixFor
XML
<response>
  <error code="24">
    <![CDATA[ No such fixfor ]]>
  </error>
</response>

Note: Passing a valid ixFixFor with a non-matching sFixFor will update the sFixFor (title) of the milestone.

Add Milestone Dependency (cmd=addFixForDependency)

URL
https://kakapo.fogbugz.com/api.asp?cmd=addFixForDependency&ixFixFor=10&ixFixForDependsOn=11&token=04t6193822pekbba09nt74ninuihk2 
fogbugz.py
fb.addFixForDependency(ixFixFor=10,
        ixFixForDependsOn=11,
        )

Parameters

Takes isFixfor and ixFixForDependsOn.

Successful Response

XML
</response>

Delete a Milestone Dependency (cmd=DeleteFixForDependency)

URL
https://kakapo.fogbugz.com/api.asp?cmd=addFixForDependency&ixFixFor=10&ixFixForDependsOn=11&token=04t6193822pekbba09nt74ninuihk2 
fogbugz.py
fb.deleteFixForDependency(ixFixFor=10,
        ixFixForDependsOn=11,
        )

Parameters

Takes isFixfor and ixFixForDependsOn.

Successful Response

XML
</response>