Updates entity objects.
API call:
All entity update statements follow this format:
void update ( APIEntity entity )
| Parameter | Description |
|---|---|
| entity | The actual API entity passed as an entire object that has its mutable values updated. |
Modified behavior for User-defined fields in the update()
method:
-
- Removing existing UDF values
- Commit the update()method with empty UDF value. If the UDF parameter is set to mandatory, the method fails as the UDF parameter cannot be empty.
-
- Updating UDF values
- Commit the update()method with the new UDF value. If you do not want to update the existing value, leave the UDF parameter and its value unchanged.
- If the UDF parameter is set to mandatory and has a default value, committing the update() method with an empty UDF value will take the default value.