...
The type name can also be appended by additional request parameters to modify the returned object.
| Method | Applicable Types | Returns | Return type | Description |
|---|---|---|---|---|
getAll(sessionID, type) | Client | List of objects | array | Returns all objects of the specified type that are available for the user. |
getSelected(sessionID, type) | Client | Object (see Data objects) | struct | Returns the currently selected object of the specified type. |
getObject(sessionID, type, objID) | Client | Object (see Data objects) | struct | Returns the object with specified ID and type. |
getObjectByName(sessionID, type, name) | Client | struct Object (see Data objects) | struct | Returns the object with specified ID and name. |
getSelectedList(sessionID, type) | Domain | List of objects | array | Returns a list of the currently selected object(s) of the specified type. |
setSelected(sessionID, type, objID) | Client | 0 | int | Sets the object with specified ID and type to be selected. |
setSelected(sessionID, type, idList) | Domain | 0 | int | Sets the objects with specified IDs and type to be selected. |
setAllSelected(sessionID, type) | Domain | 0 | int | Sets all objects of the specified type to be selected. |
isSelected(sessionID, type, objID) | Client | True if selected | boolean | Checks if the object with specified ID and type is selected. |
exists(sessionID, type, objID) | Client | True if exists | boolean | Checks if the object with specified ID and type exists. |
existsByName(sessionID, type, name) | Client | True if exists | boolean | Checks if the object with specified ID and type exists. |