You can search the file for a property's symbolic name as opposed to finding it by its display name. A property's display can vary greatly from its symbolic name, For example, display name Disposition Authority is symbolic name AuthorisingStatute.
This topic lists the API properties alphabetically by display or property name. For each property, the topic lists the classes to which the property applies and provides the following attribute information.
Attribute | Value |
---|---|
Symbolic Name | Indicates the name that uniquely identifies the property in the RM API. |
Data Type | Indicates the data type of the value or values that the property can hold. |
Cardinality | Indicates whether an object property can hold a single value (single cardinality) or a collection of multiple values (list or enumeration cardinality). |
Settability | Indicates whether only the server can set the property value (Read Only) or whether users can set the property value (Read/Write). |
Required | Indicates whether a value must be specified for the property. |
Hidden | Indicates whether the property is to be hidden from users who are not administrators. |
Data Models | Identifies the data models in which the property is used. |
Searchability | Defines how the property may be used within a SQL query statement.
|
Maximum String Length | Specifies the maximum length, in characters of a value for a String type property. When applicable, “(Uses Long Column)†is indicated for those String type properties whose Maximum String Length has the capability of being increased to a very large capacity, if necessary. |