Users.getList (Method)
Returns zero or more structures, each containing information about users who meet the criteria passed in this method's arguments.
Returns:
Users_GetList_Result (rowlimitedquery)
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| searchField | UserSearchField_EmptyString | Optional. Defaults to 'LastName'. | The field upon which to search. This can be 'LastName' or 'Organization'. |
| searchOperator | SearchOperator_EmptyString | Optional. Defaults to 'Begins With'. | A search operator or an empty string. Examples are 'Begins With', 'Contains', 'Ends With', and 'Equals'. |
| searchString | PlainText | Optional. Defaults to an empty string. | The string for which CommonSpot will search. |
| userFilter | UserTypeFilter | Optional. Defaults to 'ActiveUsers'. | The type of users to show; for example, contributors or deleted users. |
| orderBy | SQLOrderByClause_EmptyString | Optional. Defaults to an empty string. | An SQL 'order by' clause naming the field upon which the results will be sorted. |
| limit | QueryRowLimit | Optional. Defaults to '#this.LIMIT_TO_SCALABILITY_MAX#'. | An integer specifying one more than the maximum number of rows CommonSpot can return. If this value is 0, it returns all records. If it is -1, CommonSpot can return the number of records specified in the UI scalability setting. |
| excludeList | UserGroupIDList_EmptyString | Optional. Defaults to an empty string. | Either a comma-delimited list of valid user IDs being excluded from the search or an empty string, which means do not exclude any users. |
| permissionRestrictionsList | UserGroupPermissionRestrictionsList_EmptyString | Optional. Defaults to an empty string. | A comma-delimited list of one or more user and group permissions that restrict the results being returned. This can also be an empty string, which indicates that results are not restricted. If this value is 'AdminOnly', the results include only those users for which the current user is an administrator. If one of the items in this list is 'NoAdmin', the results include users that do not have an administrator. |
Context:
| License Requirements | None |
| Permission Requirements | Contributor |
| Deny Context | None |
| Require Context | None |
| Author Lock | (not required) |
| Transaction Logging | Transaction logging is disabled for this method |
| Customization | Customization is not supported for this method. |
Error Codes:
| Code | Error Message |
|---|---|
| 66027 | If a SearchField is specified, you must specify a SearchOperator. |
| 66028 | If a SearchOperator is specified, you must specify a SearchField. |
Notes:
None