Attributes

March 10, 2026 02:20 AM

3 min read

Copy
Link copied
Print

Properties are used to define the data for an Item. Attributes are meta-data for the Item or Property. They are used to control the server logic and Methods. Think of attributes like command line switches, or as arguments to a function.

In addition to the type, id, and action attributes mentioned above there are several additional attributes used to control the server. The following is the attribute reference for the <Item> tag:

Item Attributes

Attribute	Type	Usage
type	String	The ItemType name for which the Item is an instance.
id	String	The unique ID value for the Item instance.
where	String	Used instead of the id attribute to specify the WHERE clause for the search criteria. Include the table name with the column name using the dot notation: where=‘user.first_name like ‘Tom%'‘
action	String	The name of the Method (or Built in Action Method) to apply to the Item.
doGetItem	Boolean	If 0 then do not perform a final get action on the Item after the server performed that action as defined by the action attribute. Default is 1.
Used with action="get”
select	String	A comma delimited list of property names (column names) to return which is the SELECT clause in the SQL statement.
orderBy	String	A comma delimited list of property names (column names) to order the results and is the ORDER BY clause in the SQL statement.
page	Integer	The page number for the results set.
pagesize	Integer	The page size for the results set.
maxRecords	Integer	This defines the absolute maximum Items to be searched in the database.
levels	Integer	The Item configuration depth to be returned. This should be used with caution because of the performance hit due to its lack of granularity in the data fetched. Use the nested Relationships style of defining your queries to do the same thing but with far greater performance.
serverEvents	Boolean	If 0 then disable the server events improving performance. Default is 1.
isCriteria	Boolean	If 0 then include the nested structure for the Item configuration in the response but don’t use it as search criteria. Default is 1, which uses the nested structure in the request as search criteria.
related_expand	Boolean	If 0 then do not expand the related_id Property for the relationship Items to include the related Item. Another word returns its ID.
language	String	A comma-delimited list of language codes, or "*" to return all languages. Multilingual property values are returned (if present) for all specified languages.
Used with action="update” \| “edit”
version	Boolean	If 0 then don’t version an Item on update. Default is 1, which is version the Item (if it’s a versionable Item) on update.
serverEvents	Boolean	If 0 then disable the server events improving performance. Default is 1. Only ‘Update’ events are disabled, ‘Lock’ events can be executed if using ‘Edit’.

Property Attributes

Attribute

Usage

type

The ItemType name for the item instance.

keyed_name

This is the keyed_name Property for the Item referenced by the Item type Property.

condition

This is the condition value for the AML query. The condition value is any valid SELECT condition supported by the database. The following is the list of possible condition values:

Condition

Comments

The SQL conditional symbols:

=, <>, <=, >=, >, and <

are expressed as two letter mnemonic words:

eq, ne, le, ge, gt, and lt

Example:

not like

The value for the Property tag would include wild card symbols, which are % for any set of characters.

Example:<name condition="like">Tom%</name>

between

not between

This is a range condition. You would include the AND keyword in the Property tag value.

Example:

not in

This is a set-based condition where the value for the Property tag is a comma delimited list of values for the set.

Example:

<name condition="in">'Tom’, ‘Peter’, ‘Joe'</name>

is null

is not null

Possible values for the Property tag could be null or not null.

Example:

Xml:lang

Language code for multilingual properties. You must use this in conjunction with the internationalization namespace on the property tag. For example:

<i18n:name xml:lang="de” xmlns:i18n="http://www.aras.com/I18N">Rad</i18n:name>