Skip to main content

GridCreateParms

Optional parameters for the grid create operation.

Properties

NameTypeDescriptionNotes
emailParmsEmailParms[optional]
gridContentList<List<String>>If provided, the given grid contents are used for the new Grid Card. The grid contents must match the grid settings for grid size, grid cell size and cell alphabet. The administrator must have the GRIDCONTENTS:ADD permission to set the grid contents. This argument is ignored when creating unassigned grids.[optional]
groupsList<String>When creating unassigned grids the list of UUIDs of groups to which the grids will belong. If not specified, the grids will not belong to any groups.[optional]
numberOfGridsIntegerThe number of grids to create when creating unassigned grids. If not specified, it defaults to 1.[optional]
serialNumberLongIf provided, the given grid serial number is used for the new Grid Card.[optional]
stateStateEnumThe state (ACTIVE, INACTIVE, or PENDING) of the new grid. If not specified, the state defaults to PENDING. This argument is ignored when creating unassigned grids.[optional]

StateEnum

NameValue
ACTIVE"ACTIVE"
INACTIVE"INACTIVE"
UNASSIGNED"UNASSIGNED"
PENDING"PENDING"
CANCELED"CANCELED"