setAttribute

Sets the value of an attribute (extra field) on an object. Use setAttributeInteger to set values of INTEGER attributes, and setAttributeNumber to set values of NUMBER attributes.

Arguments

Name Type Description
skey string

object_type string

The object type; see getAttributeObjectTypes to determine usable values.

object_id string

The ID of the object to set the attribute value on.

id_attr_type string

The ID of the attribute type.

value string

The attribute value to set.

overwrite_existing boolean

If true, an existing value for this attribute will be overwritten with the new value. If false, and a value already exist, an exception will be raised and no changes will be made.

Return

The setAttribute method returns nothing (an unspecified object).

Exceptions

The setAttribute method may report the following exceptions: