API Reference Guide¶
Parameter Handling¶
The Primary Key (PK) column(s) cannot be modified, as they are required to identify the object to be updated. If a PK column must be changed, use the corresponding remove method instead, and then re-create the object with the appropriate add method.
Properties¶
Marker |
Description |
|---|---|
(PK) |
Part of the Primary Key. All PK parameters and at least one non-PK parameter must be provided. |
(NN) |
Not Null — the database column where the parameter value is stored is mandatory. |
(UC) |
Uppercase — input will automatically be converted to uppercase. |
Defaults for “ADD”-APIs¶
If a parameter has a default value, then passing NULL will cause the default value to be applied. Passing a single blank (’ ‘) NULL will be inserted instead.
Defaults for “Modify”-APIs¶
Defaults are provided for information only. They are not applied in the modify method.
Usage for “Modify”-APIs¶
Value |
Effect |
|---|---|
|
No change is made to the database value. |
|
Sets the database value to NULL (not allowed for parameters marked as (NN)). |