entity-resource-descriptors Schema
entity-resource-descriptors Schema

Glossary Item Box

Description

A collection of entity resource descriptors. See the entity-descriptor schema for element details.

Elements

ElementDescription
AttributeA key-value metadata element.
AttributesA collection of attributes primarily for use by extensions. ALM does not use values created by extension.
EntityResourceDescriptorThe metadata on an entity type.
EntityResourceDescriptors 
ExtensionNameThe name of the extension if the descriptor applies to an extension.
HierarchicalRootIdThe ID of the root element for hierarchical Entities
IsFirstLevelResourcetrue 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}
IsSiteEntitytrue indicates that the entity can be shared between projects.
LabelThe display name. The display name can be customized and localized.
NameThe logical name of the entity.
SecondLevelResourcesThe collection of dependent resource types.
SupportsAttachmenttrue indicates that files can be attached to this entity. The URL attribute is the regular expression for getting attachments.
SupportsCopyingtrue indicates that the entity may be copied over REST API.
SupportsDataHidingFiltertrue indicates that this entity's fields can be part of a data hiding filter.
SupportsGroupingtrue indicates that queries on this entity can be grouped. The URL attribute is the regular expression for getting the grouping header.
SupportsHistorytrue 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.
SupportsLocktrue indicates that this entity can be locked. The URL attribute is the regular expression for getting and deleting a lock.
SupportsMailingtrue indicates that this entity can be emailed. The URL attribute is the regular expression for mailing the entity.
SupportsMultiValuetrue indicates that this entity's fields can be customized in the user interface to support multiple values.
SupportsStoragetrue indicates that the entity supports storage.
SupportsSubtypestrue 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.
SupportsVCtrue 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.
SupportsWorkflowtrue indicates that events on this entity can be handled in the workflow module.
TableThe name of the database table containing the entity.

Complex Types

Complex TypeDescription
BooleanWithURLType 
IsFirstLevelResourceElementThe HTTP methods that can be used on the resource.
SupportSubtypeInfo 

Simple Types

Simple TypeDescription
AttributeSimpleType 

See Also