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`
|
|
|
|
|
2024-10-15 15:15:47 +03:00
|
|
|
| Parameter | CLI option | Type | Required | Description |
|
|
|
|
|-|-|-|-|-|
|
|
|
|
| URL | --url | String | ✔ | URL of webhook or a Bitrix24 domain, when token used |
|
2024-12-29 17:57:09 +03:00
|
|
|
| FilterStructure | --filter | Structure Of KeyAndValue | ✔ | Filter. See GetUserFilterStructure |
|
2024-10-15 15:15:47 +03:00
|
|
|
| Token | --token | String | ✖ | Access token, when app auth method used |
|
2024-10-15 10:16:04 +03:00
|
|
|
|
|
|
|
|
|
|
|
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
|
|
|
|
|
|
|
|
<br/>
|
|
|
|
|
|
|
|
:::tip
|
2024-11-21 13:27:18 +03:00
|
|
|
Method at API documentation: [user.update](https://dev.1c-bitrix.ru/rest_help/users/user_update.php)
|
2024-10-15 10:16:04 +03:00
|
|
|
:::
|
|
|
|
<br/>
|
|
|
|
|
|
|
|
|
2024-12-16 19:38:57 +03:00
|
|
|
|
2024-10-15 21:15:56 +03:00
|
|
|
```bsl title="1C:Enterprise/OneScript code example"
|
2024-12-08 12:04:47 +03:00
|
|
|
URL = "https://b24-ar17wx.bitrix24.by/rest/1/ps5...";
|
2024-10-15 10:16:04 +03:00
|
|
|
|
|
|
|
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";
|
2025-01-11 21:13:24 +03:00
|
|
|
Token = "14bb8267006e9f06006b12e400000001000...";
|
2024-10-15 10:16:04 +03:00
|
|
|
|
|
|
|
FilterStructure = New Structure;
|
|
|
|
FilterStructure.Insert("UF_DEPARTMENT_NAME", "Bitrix");
|
|
|
|
|
|
|
|
Result = OPI_Bitrix24.FindUsers(URL, FilterStructure, Token);
|
|
|
|
```
|
|
|
|
|
|
|
|
|
2024-10-20 22:36:03 +03:00
|
|
|
<Tabs>
|
|
|
|
|
|
|
|
<TabItem value="bash" label="Bash" default>
|
|
|
|
```bash
|
2024-10-22 08:59:24 +03:00
|
|
|
# JSON data can also be passed as a path to a .json file
|
|
|
|
|
2024-10-20 22:36:03 +03:00
|
|
|
oint bitrix24 FindUsers \
|
2024-10-22 08:59:24 +03:00
|
|
|
--url "b24-ar17wx.bitrix24.by" \
|
|
|
|
--filter "{'UF_DEPARTMENT_NAME':'Bitrix'}" \
|
|
|
|
--token "***"
|
2024-10-20 22:36:03 +03:00
|
|
|
```
|
|
|
|
</TabItem>
|
|
|
|
|
|
|
|
<TabItem value="bat" label="CMD/Bat" default>
|
|
|
|
```batch
|
2024-10-22 08:59:24 +03:00
|
|
|
:: JSON data can also be passed as a path to a .json file
|
|
|
|
|
2024-10-20 22:36:03 +03:00
|
|
|
oint bitrix24 FindUsers ^
|
2024-10-22 08:59:24 +03:00
|
|
|
--url "b24-ar17wx.bitrix24.by" ^
|
|
|
|
--filter "{'UF_DEPARTMENT_NAME':'Bitrix'}" ^
|
|
|
|
--token "***"
|
2024-10-20 22:36:03 +03:00
|
|
|
```
|
|
|
|
</TabItem>
|
|
|
|
</Tabs>
|
2024-10-15 10:16:04 +03:00
|
|
|
|
|
|
|
|
|
|
|
```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
|
|
|
|
}
|
|
|
|
}
|
|
|
|
```
|