2024-10-15 10:50:56 +03:00
|
|
|
---
|
2024-10-15 10:16:04 +03:00
|
|
|
sidebar_position: 6
|
|
|
|
|
---
|
|
|
|
|
|
2024-10-15 10:50:56 +03:00
|
|
|
import Tabs from '@theme/Tabs';
|
|
|
|
|
import TabItem from '@theme/TabItem';
|
|
|
|
|
|
2024-10-15 10:16:04 +03:00
|
|
|
# Find users
|
|
|
|
|
Gets the list of users according to the specified filter
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
`Function FindUsers(Val URL, Val FilterStructure, Val Token = "") Export`
|
|
|
|
|
|
|
|
|
|
| Parameter | CLI option | Type | Description |
|
|
|
|
|
|-|-|-|-|
|
|
|
|
|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
|
|
|
|
| FilterStructure | --filter | Structure of KeyAndValue | Filter. See GetUserFilterStructure |
|
|
|
|
|
| Token | --token | String | Access token, when app auth method used |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
|
|
|
|
|
|
|
|
|
|
<br/>
|
|
|
|
|
|
|
|
|
|
:::tip
|
|
|
|
|
Method at API documentation: [user.update](https://dev.1c-bitrix.ru/rest_help/users/user_update.php)
|
|
|
|
|
:::
|
|
|
|
|
<br/>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```bsl title="Code example"
|
|
|
|
|
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
|
|
|
|
|
|
|
|
|
FilterStructure = New Structure;
|
|
|
|
|
FilterStructure.Insert("NAME" , "Vitaly");
|
|
|
|
|
FilterStructure.Insert("LAST_NAME" , "Alpaca");
|
|
|
|
|
FilterStructure.Insert("WORK_POSITION" , "DevOps engineer");
|
|
|
|
|
FilterStructure.Insert("UF_DEPARTMENT_NAME", "Marketing department");
|
|
|
|
|
FilterStructure.Insert("USER_TYPE" , "employee");
|
|
|
|
|
|
|
|
|
|
Result = OPI_Bitrix24.FindUsers(URL, FilterStructure);
|
|
|
|
|
|
|
|
|
|
URL = "b24-ar17wx.bitrix24.by";
|
|
|
|
|
Token = "21750a67006e9f06006b12e400000001000...";
|
|
|
|
|
|
|
|
|
|
FilterStructure = New Structure;
|
|
|
|
|
FilterStructure.Insert("UF_DEPARTMENT_NAME", "Bitrix");
|
|
|
|
|
|
|
|
|
|
Result = OPI_Bitrix24.FindUsers(URL, FilterStructure, Token);
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```json title="Result"
|
|
|
|
|
{
|
|
|
|
|
"result": [],
|
|
|
|
|
"time": {
|
|
|
|
|
"start": 1728454935.77575,
|
|
|
|
|
"finish": 1728454935.81785,
|
|
|
|
|
"duration": 0.0420989990234375,
|
|
|
|
|
"processing": 0.0130829811096191,
|
|
|
|
|
"date_start": "2024-10-09T09:22:15+03:00",
|
|
|
|
|
"date_finish": "2024-10-09T09:22:15+03:00",
|
|
|
|
|
"operating_reset_at": 1728455535,
|
|
|
|
|
"operating": 0
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
```
|
