Help

Property definitions are the basis of they way you configure a project. Once a project is configured, the list of property definitions is a useful thing to have so that you can determine the card table structure for the project. One of the uses of this API is to get the column names of each property definition, to be used when you update a card resource. The only currently supported operation is to get a list of all the property definitions in a project.

Before using this API, we recommend that familiarize yourself with property definitions.

The attributes of a property definition resource are described below, along with their data type. Also included with each attribute is whether you are allowed to update the value. System generated field like id are provided only as information about the card and cannot be updated through the API.

property definitions resource xml - attributes

• id: Integer; read only, system assigned unique identifier for a property definition.
• name: String; this is the name of the property definition.
• column_name: String; read only, this field is the name of the database column that the property definition creates in the cards table of the project. These column names determine the attributes in a card resource for this project.
• data_type: String; read only, this field determine what data type of the property definition. Currently can be string, numeric, date, user, or card.
• transition_only: Boolean; this determines if the property can be updated directly or only through a transition.
• formula: String; for formula properties, the formula property definition. Empty otherwise.
• is_numeric: Boolean; determines if the property definition is a numeric property. Only Managed/Unmanaged numeric properties have this set to true.
• description: String;
• restricted: Boolean; determines if a managed property definition can have any more values added to it through card show/edit pages. This corresponds to 'locked' in the Mingle card properties page.
• hidden: Boolean; determines if team members can see the property in the card anywhere other than in MQL reports.

Reference

        Request Method: GET
        URL: /projects/project_identifier/property_definitions.xml
        Parameters: NA
      

Example

        GET

        https://yourname:password@your.mingle.server:8080/projects/test_project/property_definitions.xml
      

Explanation

The above is an example of a GET request to a Mingle server running at your.mingle.server, post 8080. The request is made with the authorization credentials of yourname/password. The URL of projects/test_project/property_definitions.xml represents the listing of all property definition resources for the project with identifier test_project.

Result

If you were authorized to perform the operation, and the resource was available, you should get a xml document that looks something like the following.

<records type="array">
  <record>
    <column_name>cp_status</column_name>
    <description/>
    <formula/>
    <hidden type="boolean">false</hidden>
    <id type="integer">950</id>
    <is_numeric type="boolean">false</is_numeric>
    <name>Status</name>
    <position type="integer"/>
    <restricted type="boolean">false</restricted>
    <transition_only type="boolean">true</transition_only>
  </record>
  .
  .
  .
  <record>
    <column_name>cp_release</column_name>
    <description/>
    <formula/>
    <hidden type="boolean">false</hidden>
    <id type="integer">960</id>
    <is_numeric type="boolean">true</is_numeric>
    <name>Release</name>
    <position type="integer"/>
    <restricted type="boolean">true</restricted>
    <transition_only type="boolean">false</transition_only>
  </record>
</records>