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