Note: The star and unstar commands are only available with Version 8.2+ of the API.

Star

cmd=star

Parameters
Requires sType (Bug, WikiPage, or DiscussTopic) and ixItem and optionally takes ixPerson (only admins can use this parameter).
Example
https://kakapo.fogbugz.com/api.asp?cmd=star&sType=Bug&ixItem=1001&token=04t6193822pekbba09nt74ninuihk2
Returns
Empty response.

Parameters

  • sType
    • One of the following strings: Bug, WikiPage, or DiscussTopic
  • ixItem
    • Value of the ixBug, ixWikiPage, or ixDiscussTopic. Must correspond with the value of sType.
  • ixPerson
    • Optional (Only admins may use this parameter). When absent, will star for current user.

Example

URL
https://kakapo.fogbugz.com/api.asp?cmd=star&sType=Bug&ixItem=1001&token=04t6193822pekbba09nt74ninuihk2
fogbugz.py
fb.star(sType="Bug", ixEvent=1000)

Successful Response

XML
</response>

Unstar

cmd=unstar

Parameters
Requires sType (Bug, WikiPage, or DiscussTopic) and ixItem and optionally takes ixPerson (only admins can use this parameter).
Example
https://kakapo.fogbugz.com/api.asp?cmd=unstar&sType=Bug&ixItem=1001&token=04t6193822pekbba09nt74ninuihk2
Returns
Empty response.

Parameters

  • sType
    • One of the following strings: Bug, WikiPage, or DiscussTopic
  • ixItem
    • Value of the ixBug, ixWikiPage, or ixDiscussTopic. Must correspond with the value of sType.
  • ixPerson
    • Optional (Only admins may use this parameter). When absent, will star for current user.

Example

URL
https://kakapo.fogbugz.com/api.asp?cmd=unstar&sType=Bug&ixItem=1001&token=04t6193822pekbba09nt74ninuihk2
fogbugz.py
fb.unstar(sType="Bug", ixEvent=1000)

Successful Response

XML
</response>

List Starred Items

cmd=star

Parameters
Requires ixPerson.
Example
https://kakapo.fogbugz.com/api.asp?cmd=listStarredItems&ixPerson=2&token=2lplnu75qtetm4io6leivv1j6pbv3j
Returns
List of starred items for provided ixPerson.

Example

URL
https://kakapo.fogbugz.com/api.asp?cmd=listStarredItems&ixPerson=2&token=2lplnu75qtetm4io6leivv1j6pbv3j
fogbugz.py
fb.listStarredItems(ixPerson=2)

Successful Response

XML
<response>
	<favorites>
		<favorite>
			<sType>
				<![CDATA[ Bug ]]>
			</sType>
			<ixItem>5303</ixItem>
			<ixDocList>1</ixDocList>
			<nPos>1</nPos>
			<sBugTitle>
				<![CDATA[ Product Intro - Bulk Edit ]]>
			</sBugTitle>
			<ixBugEventLatest>591</ixBugEventLatest>
			<ixBugEventLastView>591</ixBugEventLastView>
			<sWikiHeadline/>
			<ixRevisionLatest/>
			<ixWiki/>
			<ixRevisionLastView/>
			<sDiscussHeadline/>
			<ixDiscussTopicLastView/>
			<ixArea/>
			<ixDiscussGroup/>
			<sURLName/>
			<ixAreaNonSpam/>
			<fFavorite>true</fFavorite>
			<cReplies>0</cReplies>
			<ixDiscussTopicLatest/>
			<dt/>
		</favorite>
	</favorites>
</response>