Overview

This article explains how to star or unstar an item, wiki, or discussion using the API Token. The star and unstar commands are only available with Version 8.2+ of the API.

Steps

To carry out all the below activities, the administrator needs to have the API Token generated.

The below mentioned parameters are required for both Star and Unstar strings.

Parameters required

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: This is an optional parameter and only admin can use this. When absent, will star for the current user.

Star

The command to use is cmd=star.
Use of Login URL example:

https://kakapo.fogbugz.com/api.asp?cmd=star&sType=Bug&ixItem=1001&token=04t6193822pekbba09nt74ninuihk2

Use of Fogbugz.py:

fb.star(sType="Bug", ixEvent=1000)

If Success, the response return should be </response>.

Unstar

The command to use is cmd=unstar.
Use of Login URL example:

https://kakapo.fogbugz.com/api.asp?cmd=unstar&sType=Bug&ixItem=1001&token=04t6193822pekbba09nt74ninuihk2

Use of Fogbugz.py:

fb.unstar(sType="Bug", ixEvent=1000)

If Success, the response return should be </response>.

You can also list down all the starred Items using the below String with

Command cmd=listStarredItems;
Parameter ixPerson=2.

https://kakapo.fogbugz.com/api.asp?cmd=listStarredItems&ixPerson=2&Token=2lplnu75qtetm4io6leivv1j6pbv3j