favorite Schema
Favorite Element
favorite Schema : Favorite Element

Glossary Item Box

Description

A user setting.
Namespace (none)

Diagram

Layout Element Filter Element is-public Element owner Element name Element parent-id Element module-id Element id Element Sequence Favorite Element

Overview

Favorite
A user setting.
Sequence
id optional xs:int
The Favorite ID.
module-id optional xs:int
The ID of the module this favorite belongs to. The possible values are from the MODULES table in the project database.
parent-id optional xs:int
The ID of the parent favorite folder.
name optional xs:string
The name of the favorite.
owner optional xs:string
The user who created this favorite.
is-public optional xs:boolean
Indicates if the favorite is public (visible to all users) or visible only to owner.
Filter optional
The filter definition. The filter object of the favorite. This filter object is used when querying resources.
Layout optional
Describes the presentation in the ALM user interface. For example, which columns are displayed. Describes the presentation in the ALM user interface. For example, which columns are displayed.

Source

<xs:element name="Favorite" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>
            A user setting.
        </xs:documentation>
  </xs:annotation>
  <xs:complexType>
    <xs:sequence>
      <xs:element name="id" type="xs:int" minOccurs="0" maxOccurs="1">
        <xs:annotation>
          <xs:documentation>
                            The Favorite ID.
                        </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="module-id" type="xs:int" minOccurs="0" maxOccurs="1">
        <xs:annotation>
          <xs:documentation>
                            The ID of the module this favorite belongs to.
                            The possible values are from the MODULES table in the project database.
                        </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="parent-id" type="xs:int" minOccurs="0" maxOccurs="1">
        <xs:annotation>
          <xs:documentation>
                            The ID of the parent favorite folder.
                        </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="name" type="xs:string" minOccurs="0" maxOccurs="1">
        <xs:annotation>
          <xs:documentation>
                            The name of the favorite.
                        </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="owner" type="xs:string" minOccurs="0" maxOccurs="1">
        <xs:annotation>
          <xs:documentation>
                            The user who created this favorite.
                        </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="is-public" type="xs:boolean" minOccurs="0" maxOccurs="1">
        <xs:annotation>
          <xs:documentation>
                            Indicates if the favorite is public (visible to all users) or visible only to owner.
                        </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element ref="Filter" minOccurs="0" maxOccurs="1"></xs:element>
      <xs:element ref="Layout" minOccurs="0" maxOccurs="1"></xs:element>
    </xs:sequence>
  </xs:complexType>
</xs:element>

See Also