entity-resource-descriptors Schema
EntityResourceDescriptor Element
entity-resource-descriptors Schema : EntityResourceDescriptor Element

Glossary Item Box

Description

The metadata on an entity type.
Namespace (none)

Diagram

SecondLevelResources Element IsFirstLevelResource Element Attributes Element IsSiteEntity Element ExtensionName Element HierarchicalRootId Element SupportsStorage Element SupportsCopying Element SupportsSubtypes Element SupportsVC Element SupportsDataHidingFilter Element SupportsWorkflow Element SupportsMultiValue Element SupportsMailing Element SupportsGrouping Element SupportsLock Element SupportsAttachment Element SupportsHistory Element Label Element Name Element Table Element Sequence EntityResourceDescriptor Element

Overview

EntityResourceDescriptor
The metadata on an entity type.
baseUrl required xs:string
All the relative URLs and URL regular expressions returned have this string as their base URL.
collectionName required xs:string
The name of the collection this entity type belongs to.
Sequence
Table xs:string
The name of the database table containing the entity.
Name xs:string
The logical name of the entity.
Label xs:string
The display name. The display name can be customized and localized.
SupportsHistory BooleanWithURLType Complex Type
true indicates that this entity's fields can be customized in the user interface to support history. The URL attribute is the regular expression for getting history records.
SupportsAttachment BooleanWithURLType Complex Type
true indicates that files can be attached to this entity. The URL attribute is the regular expression for getting attachments.
SupportsLock BooleanWithURLType Complex Type
true indicates that this entity can be locked. The URL attribute is the regular expression for getting and deleting a lock.
SupportsGrouping BooleanWithURLType Complex Type
true indicates that queries on this entity can be grouped. The URL attribute is the regular expression for getting the grouping header.
SupportsMailing BooleanWithURLType Complex Type
true indicates that this entity can be emailed. The URL attribute is the regular expression for mailing the entity.
SupportsMultiValue xs:boolean
true indicates that this entity's fields can be customized in the user interface to support multiple values.
SupportsWorkflow xs:boolean
true indicates that events on this entity can be handled in the workflow module.
SupportsDataHidingFilter xs:boolean
true indicates that this entity's fields can be part of a data hiding filter.
SupportsVC BooleanWithURLType Complex Type
true indicates that versions of this entity can be saved if version control is enabled for the project. The URL attribute is the regular expression for getting versions.
SupportsSubtypes SupportSubtypeInfo Complex Type
true indicates that there can be subtypes of this entity. The URL attribute is the regular expression for getting the list of subtypes. Even the value is false, there may be types implementation, different from the common subtypes mechanism. In this case subTypeFieldName parameter will hold the entity type field name. If subTypeFieldName parameter is not present, it means that there is neither default subtypes implementation, nor special types implementation for this entity.
SupportsCopying BooleanWithURLType Complex Type
true indicates that the entity may be copied over REST API.
SupportsStorage BooleanWithURLType Complex Type
true indicates that the entity supports storage.
HierarchicalRootId optional xs:int
The ID of the root element for hierarchical Entities
ExtensionName xs:string
The name of the extension if the descriptor applies to an extension.
IsSiteEntity xs:boolean
true indicates that the entity can be shared between projects.
Attributes
A collection of attributes primarily for use by extensions. ALM does not use values created by extension.
IsFirstLevelResource IsFirstLevelResourceElement Complex Type
true indicates that the collection name for this entity type is directly under the project name in the URL. For example, /domains/{domain-name}/projects/{project-name}/{first level resource collection}
SecondLevelResources optional
The collection of dependent resource types.

Attributes

NameTypeUseDefaultFixedDescription
baseUrlxs:stringrequired  All the relative URLs and URL regular expressions returned have this string as their base URL.
collectionNamexs:stringrequired  The name of the collection this entity type belongs to.

Source

<xs:element name="EntityResourceDescriptor" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>
                The metadata on an entity type.
            </xs:documentation>
  </xs:annotation>
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="Table" />
      <xs:element ref="Name" />
      <xs:element ref="Label" />
      <xs:element ref="SupportsHistory" />
      <xs:element ref="SupportsAttachment" />
      <xs:element ref="SupportsLock" />
      <xs:element ref="SupportsGrouping" />
      <xs:element ref="SupportsMailing" />
      <xs:element ref="SupportsMultiValue" />
      <xs:element ref="SupportsWorkflow" />
      <xs:element ref="SupportsDataHidingFilter" />
      <xs:element ref="SupportsVC" />
      <xs:element ref="SupportsSubtypes" />
      <xs:element ref="SupportsCopying" />
      <xs:element ref="SupportsStorage" />
      <xs:element ref="HierarchicalRootId" minOccurs="0" />
      <xs:element ref="ExtensionName" />
      <xs:element ref="IsSiteEntity" />
      <xs:element ref="Attributes" />
      <xs:element ref="IsFirstLevelResource" />
      <xs:element ref="SecondLevelResources" minOccurs="0" />
    </xs:sequence>
    <xs:attribute name="baseUrl" type="xs:string" use="required">
      <xs:annotation>
        <xs:documentation>
                    All the relative URLs and URL regular expressions returned have this string as their base URL.
                </xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="collectionName" type="xs:string" use="required">
      <xs:annotation>
        <xs:documentation>
                    The name of the collection this entity type belongs to.    
                </xs:documentation>
      </xs:annotation>
    </xs:attribute>
  </xs:complexType>
</xs:element>

See Also