NamedUserItem

In the Item Service, while RelatedItems are the most basic items, more complex items such as collections, scripts, and user configs are of the NamedUserItem super-type. These items follow the NamedUserItem type schema, where you define its item class, and give it a name.

NamedUserItem classes

You can define a NamedUserItem as one of the following item classes:

• NamedUserCollection: A collection of RelatedItems
  • NamedFileCollection: A collection of related FileItems
  • NamedTelemetryCollection: A collection of related telemetry items
• User config: A configuration object with parameters and values you define
• Script: A script object containing a script you create, which implements a piece of logic
• NamedCompositeItem: Groups named user, file, and telemetry collections.

Figure: NamedUserItem user types

To define a NamedUserItem subtype, in your object, add an _itemClass attribute and enter one of the following values:

• NamedUserCollection
• NamedFileCollection
• NamedTelemetryCollection
• Script
• UserConfig
• NamedCompositeItem

The following code example is an object that is defined as a NamedUserCollection:

{
  _name: "Building Elements Collection",
  _itemClass: "NamedUserCollection",
}

Schema

For more information on the NamedUserItem super-type and its properties, see the NamedUserItem schema.

API

You can create and manage NamedUserItems with the IafItemSvc JavaScript Platform API or the Item Service REST API.