Bulk Item Class

A bulk item represents a file or other large binary object. The file may be a 3D model, an image, movie, firmware or other file associated with a device. A bulk item class provides information about how to read (and write, if supported) the file data associated with a bulk item. A bulk item class defines several attributes about a bulk item.

Attributes

Class attributes are part of the bulk item class; they apply to all instances of a bulk item of this class.

ID (Required)

A bulk item class’s id is a string identifying an individual bulk item class. This must be unique within the Library or parent object that contains the bulk item class.

Name (Required)

A string containing the human-readable name of the bulk item.

Description

A string that describes the purpose of a bulk item in human-readable language.

File Type (Required)

A bulk item class’s filetype specifies how to interpret the data stored with the bulk item.

The possible types are:

movie	Represents video containing audio
video	Represents video that doesn’t contain audio
image	Represents image data
audio	Represents audio that doesn’t contain video
3dmodel	A 3D representation
symbol	A 2D symbol representation
other	All other file types

File Formats (Required)

A comma separated list of possible file extensions. File extensions are not case-sensitive.

Examples may include: jpg, obj, mov.

Markup

UDR Type: bulkitemclass
Members:

Key

Value Type

Represents

id

string

ID (Required)

name

string

Name (Required)

description

string

Description

filetype

string

File Type (Required)

fileformats

string

File Formats (Required)

Example:

{
  "udrtype": "bulkitemclass",
  "id": "gobo-image",
  "name": "Gobo Image",
  "description": "The image of a gobo",
  "filetype": "image",
  "fileformats": "jpg,png"
}