Loading

Help documentation

Back to previous page

Favorite API

Personal favorites cannot be accessed via Mingle API. Favorite API is for team favorites only.

Team favorites

Team favorites are a shortcut for team members to quickly access card views or wiki pages that are used often in a project. The Favorites API allows users to access a list of all team favorites and tabs on a project. They can then use the Card API to get all cards for a specified team favorite.

Structure of a favorite resource

Please note that all the API resources and examples refer to v2 of the API. Support for v1 of the API was deprecated in fall 2012. Please refer to this announcement in our Mingle community for more information about this deprecation.

The structure of the favorite's resource and its attributes are described below, along with their data type.

favorite resource xml - attributes
  • id: Integer; read only, system assigned unique identifier for this favorite.
  • name: String; user given name for this favorite.
  • project: Resource; name and identifier of the project for this favorite; both String.
  • favorited_type: String; read only, type of favorite, 'CardListView' or 'Page'.
  • tab_view: Boolean; the tab status indicator for this favorite.

Get all team favorites for a project

Reference

    Request Method: GET
    URL: /api/v2/projects/project_identifier/favorites.xml

Example

    GET

    http://yourname:password@your.mingle.server:8080/api/v2/projects/test_project/favorites.xml

Explanation

The above is an example of a GET request to retrieve all team favorites from the project with the identifier "test_project". This will return all team favorites including saved card views, wiki pages and tabs for the project.

Result

If you were authorized to perform the operation, and the operation succeeded, you will be returned an array of favorites resources.

<?xml version="1.0" encoding="UTF-8"?>
<favorites type="array">
  <favorite>
    <id type="integer">33</id>
    <name>Story Wall</name>
    <project url="http://localhost:8080/api/v2/projects/test_project.xml">
      <name>test project</name>
      <identifier>test_project</identifier>
    </project>
    <favorited_type>CardListView</favorited_type>
    <tab_view type="boolean">true</tab_view>
  </favorite>
  ...
  <favorite>
    <id type="integer">76</id>
    <name>Lo-fi prototype</name>
    <project url="http://localhost:8080/api/v2/projects/test_project.xml">
      <name>test project</name>
      <identifier>test_project</identifier>
    </project>
    <favorited_type>Page</favorited_type>
    <tab_view type="boolean">false</tab_view>
  </favorite>
</favorites>