1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2024-12-25 02:42:28 +02:00

Новые страницы документации

This commit is contained in:
Anton 2024-07-30 22:48:29 +03:00
parent a298e43709
commit f3ae27ce71
219 changed files with 5568 additions and 102 deletions

View File

@ -18,7 +18,7 @@ sidebar_position: 4
| Comment | --comment | String | Comment identifier |
Returns: Map Of KeyAndValue - serialized JSON response from Airtable
Returns: Map Of KeyAndValue - serialized JSON response from Airtable
<br/>

View File

@ -15,7 +15,7 @@ sidebar_position: 1
| Indent | --offset | String | Next page identifier of the base list from the previous request |
Returns: Map Of KeyAndValue - serialized JSON response from Airtable
Returns: Map Of KeyAndValue - serialized JSON response from Airtable
<br/>

View File

@ -16,7 +16,7 @@ sidebar_position: 11
| Token | --token | String | Access token, when app auth method used |
Returns: Structure of KeyAndValue - Fields structure
Returns: Structure of KeyAndValue - Fields structure
<br/>

View File

@ -1,4 +1,4 @@
{
"label": "Catalogs managment",
"position": "10"
"position": "11"
}

View File

@ -1,5 +1,5 @@
---
sidebar_position: 4
sidebar_position: 5
---
# Add users to chat

View File

@ -1,5 +1,5 @@
---
sidebar_position: 7
sidebar_position: 8
---
# Change chat color

View File

@ -1,5 +1,5 @@
---
sidebar_position: 9
sidebar_position: 10
---
# Change chat owner

View File

@ -1,5 +1,5 @@
---
sidebar_position: 8
sidebar_position: 9
---
# Change chat picture

View File

@ -1,5 +1,5 @@
---
sidebar_position: 6
sidebar_position: 7
---
# Change chat title

View File

@ -1,5 +1,5 @@
---
sidebar_position: 5
sidebar_position: 6
---
# Delete user from chat

View File

@ -1,5 +1,5 @@
---
sidebar_position: 10
sidebar_position: 11
---
# Disable chat notifications

View File

@ -1,5 +1,5 @@
---
sidebar_position: 11
sidebar_position: 12
---
# Enable chat notifications

View File

@ -1,5 +1,5 @@
---
sidebar_position: 17
sidebar_position: 20
---
# Get chat files folder

View File

@ -1,5 +1,5 @@
---
sidebar_position: 14
sidebar_position: 15
---
# Get chat members list

View File

@ -1,5 +1,5 @@
---
sidebar_position: 12
sidebar_position: 13
---
# Get chat messages list

View File

@ -1,5 +1,5 @@
---
sidebar_position: 18
sidebar_position: 21
---
# Get chats structure
@ -14,7 +14,7 @@ sidebar_position: 18
| Clear | --empty | Boolean | True > structure with empty values, False > field types at values |
Returns: Structure of KeyAndValue - Fields structure
Returns: Structure of KeyAndValue - Fields structure
<br/>

View File

@ -1,5 +1,5 @@
---
sidebar_position: 13
sidebar_position: 14
---
# Get dialog

View File

@ -0,0 +1,54 @@
---
sidebar_position: 17
---
# Get user status
Gets the status (online) of the current user
`Function GetUserStatus(Val URL, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| 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: [im.user.status.get](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11497)
:::
<br/>
```bsl title="Code example"
URL = FunctionParameters["Bitrix24_URL"];
Result = OPI_Bitrix24.GetUserStatus(URL);
URL = FunctionParameters["Bitrix24_Domain"];
Token = FunctionParameters["Bitrix24_Token"];
Result = OPI_Bitrix24.GetUserStatus(URL, Token);
```
```sh title="CLI command example"
oint bitrix24 GetUserStatus --url %url% --token %token%
```
```json title="Result"
{
"error": "expired_token",
"error_description": "The access token provided has expired."
}
```

View File

@ -0,0 +1,96 @@
---
sidebar_position: 4
---
# Get users
Get users information for dialog
`Function GetUsers(Val URL, Val UserIDs, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| UserIDs | --users | Array of String, Number | Usesr ID or array of users IDs |
| 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: [im.user.list.get ](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11493)
:::
<br/>
```bsl title="Code example"
URL = FunctionParameters["Bitrix24_URL"];
ArrayOfUsers = New Array;
ArrayOfUsers.Add(1);
ArrayOfUsers.Add(10);
Result = OPI_Bitrix24.GetUsers(URL, ArrayOfUsers);
URL = FunctionParameters["Bitrix24_Domain"];
Token = FunctionParameters["Bitrix24_Token"];
UserIDs = 10;
Result = OPI_Bitrix24.GetUsers(URL, UserIDs, Token);
```
```sh title="CLI command example"
oint bitrix24 GetUsers --url %url% --users %users% --token %token%
```
```json title="Result"
{
"result": {
"10": {
"id": 10,
"active": true,
"name": "Techno Pizza",
"first_name": "Techno",
"last_name": "Pizza",
"work_position": null,
"color": "#ab7761",
"avatar": "",
"gender": "M",
"birthday": "",
"extranet": false,
"network": false,
"bot": false,
"connector": false,
"external_auth_id": "socservices",
"status": "online",
"idle": false,
"last_activity_date": "2024-07-13T18:36:23+00:00",
"mobile_last_date": false,
"absent": false,
"departments": [
1
],
"phones": false
}
},
"time": {
"start": 1722083796.56495,
"finish": 1722083796.59641,
"duration": 0.031451940536499,
"processing": 0.00229191780090332,
"date_start": "2024-07-27T12:36:36+00:00",
"date_finish": "2024-07-27T12:36:36+00:00",
"operating_reset_at": 1722084396,
"operating": 0
}
}
```

View File

@ -1,5 +1,5 @@
---
sidebar_position: 16
sidebar_position: 19
---
# Read all

View File

@ -1,5 +1,5 @@
---
sidebar_position: 15
sidebar_position: 16
---
# Send write notification

View File

@ -0,0 +1,66 @@
---
sidebar_position: 18
---
# Set user status
Sets the status (online) of the current user
`Function SetUserStatus(Val URL, Val Status, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| Status | --status | String, Number | Status value: online, dnd, away |
| 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: [im.user.status.set](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11499)
:::
<br/>
```bsl title="Code example"
URL = FunctionParameters["Bitrix24_URL"];
Status = "dnd";
Result = OPI_Bitrix24.SetUserStatus(URL, Status);
URL = FunctionParameters["Bitrix24_UR"];
Token = FunctionParameters["Bitrix24_Token"];
Status = "away";
Result = OPI_Bitrix24.SetUserStatus(URL, Status, Token);
```
```sh title="CLI command example"
oint bitrix24 SetUserStatus --url %url% --status %status% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1722083795.3692,
"finish": 1722083795.39818,
"duration": 0.0289750099182129,
"processing": 0.00522208213806152,
"date_start": "2024-07-27T12:36:35+00:00",
"date_finish": "2024-07-27T12:36:35+00:00",
"operating_reset_at": 1722084395,
"operating": 0
}
}
```

View File

@ -1,4 +1,4 @@
{
"label": "Chats and dialogs managment",
"position": "12"
"position": "13"
}

View File

@ -14,7 +14,7 @@ sidebar_position: 9
| Clear | --empty | Boolean | True > structure with empty valuse, False > field descriptions at values |
Returns: Structure of KeyAndValue - Fields structure
Returns: Structure of KeyAndValue - Fields structure
<br/>

View File

@ -1,4 +1,4 @@
{
"label": "Comments and results managment",
"position": "6"
"position": "7"
}

View File

@ -0,0 +1,75 @@
---
sidebar_position: 2
---
# Add custom task field
Adds a new custom field to be added to the task
`Function AddCustomTaskField(Val URL, Val Type, Val Name, Val ExternalID = "", Val Title = "", Val Signature = "", Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| Type | --type | String | Field type: string, double, date, boolean |
| Name | --fieldname | String | Text identifier (name) of the field |
| ExternalID | --externalid | String | Text identifier for external integration |
| Title | --title | String | Field title |
| Signature | --label | Structure of KeyAndValue | Form label. Key: en or ru, Value: Lable text |
| 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: [task.item.userfield.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/add.php)
:::
<br/>
```bsl title="Code example"
URL = FunctionParameters["Bitrix24_URL"];
Type = "date";
Name = "BIRTHDAY_FIELD";
Result = OPI_Bitrix24.AddCustomTaskField(URL, Type, Name);
URL = FunctionParameters["Bitrix24_URL"];
Token = FunctionParameters["Bitrix24_Token"];
Type = "string";
Name = "TEXT_FIELD";
ExternalID = "BITRIX_TEXT_FIELD";
Title = "Text field";
Signature = New Structure("en,ru", "Some field", "Nekotoroe pole");
Result = OPI_Bitrix24.AddCustomTaskField(URL, Type, Name, ExternalID, Title, Signature, Token);
```
```sh title="CLI command example"
oint bitrix24 AddCustomTaskField --url %url% --type %type% --fieldname %fieldname% --externalid %externalid% --title %title% --label %label% --token %token%
```
```json title="Result"
{
"result": 261,
"time": {
"start": 1722114794.52732,
"finish": 1722114794.59725,
"duration": 0.0699310302734375,
"processing": 0.0470340251922607,
"date_start": "2024-07-27T21:13:14+00:00",
"date_finish": "2024-07-27T21:13:14+00:00",
"operating_reset_at": 1722115394,
"operating": 0
}
}
```

View File

@ -0,0 +1,64 @@
---
sidebar_position: 5
---
# Delete custom task field
Deletes a custom task field
`Function DeleteCustomTaskField(Val URL, Val FieldID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FieldID | --fieldid | String, Number | Field ID for deletion |
| 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: [task.item.userfield.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/delete.php)
:::
<br/>
```bsl title="Code example"
URL = FunctionParameters["Bitrix24_URL"];
FieldID = FunctionParameters["Bitrix24_HookTaskFieldID"];
Result = OPI_Bitrix24.DeleteCustomTaskField(URL, FieldID);
URL = FunctionParameters["Bitrix24_UR"];
Token = FunctionParameters["Bitrix24_Token"];
FieldID = FunctionParameters["Bitrix24_TaskFieldID"];
Result = OPI_Bitrix24.DeleteCustomTaskField(URL, FieldID, );
```
```sh title="CLI command example"
oint bitrix24 DeleteCustomTaskField --url %url% --fieldid %fieldid% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1722114801.22925,
"finish": 1722114801.26696,
"duration": 0.0377130508422852,
"processing": 0.0185980796813965,
"date_start": "2024-07-27T21:13:21+00:00",
"date_finish": "2024-07-27T21:13:21+00:00",
"operating_reset_at": 1722115401,
"operating": 0
}
}
```

View File

@ -0,0 +1,186 @@
---
sidebar_position: 4
---
# Gets a custom task field
Get custom task field data
`Function GetCustomTaskField(Val URL, Val FieldID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FieldID | --fieldid | String, Number | Field ID for retrieval |
| 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: [task.item.userfield.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/get.php)
:::
<br/>
```bsl title="Code example"
URL = FunctionParameters["Bitrix24_URL"];
FieldID = FunctionParameters["Bitrix24_HookTaskFieldID"];
Result = OPI_Bitrix24.GetCustomTaskField(URL, FieldID);
URL = FunctionParameters["Bitrix24_UR"];
Token = FunctionParameters["Bitrix24_Token"];
FieldID = FunctionParameters["Bitrix24_TaskFieldID"];
Result = OPI_Bitrix24.GetCustomTaskField(URL, FieldID, );
```
```sh title="CLI command example"
oint bitrix24 GetCustomTaskField --url %url% --fieldid %fieldid% --token %token%
```
```json title="Result"
{
"result": {
"ID": "261",
"ENTITY_ID": "TASKS_TASK",
"FIELD_NAME": "UF_TEXT_FIELD",
"USER_TYPE_ID": "string",
"XML_ID": "NEW_TEXT_FIELD",
"SORT": "100",
"MULTIPLE": "N",
"MANDATORY": "N",
"SHOW_FILTER": "N",
"SHOW_IN_LIST": "Y",
"EDIT_IN_LIST": "Y",
"IS_SEARCHABLE": "N",
"SETTINGS": {
"SIZE": 20,
"ROWS": 1,
"REGEXP": "",
"MIN_LENGTH": 0,
"MAX_LENGTH": 0,
"DEFAULT_VALUE": ""
},
"EDIT_FORM_LABEL": {
"ar": "",
"br": "",
"de": "",
"en": "Updated field",
"fr": "",
"id": "",
"it": "",
"ja": "",
"la": "",
"ms": "",
"pl": "",
"ru": "Izmenennoe pole",
"sc": "",
"tc": "",
"th": "",
"tr": "",
"ua": "",
"vn": ""
},
"LIST_COLUMN_LABEL": {
"ar": "Text field",
"br": "Text field",
"de": "Text field",
"en": "Text field",
"fr": "Text field",
"id": "Text field",
"it": "Text field",
"ja": "Text field",
"la": "Text field",
"ms": "Text field",
"pl": "Text field",
"ru": "Text field",
"sc": "Text field",
"tc": "Text field",
"th": "Text field",
"tr": "Text field",
"ua": "Text field",
"vn": "Text field"
},
"LIST_FILTER_LABEL": {
"ar": "Text field",
"br": "Text field",
"de": "Text field",
"en": "Text field",
"fr": "Text field",
"id": "Text field",
"it": "Text field",
"ja": "Text field",
"la": "Text field",
"ms": "Text field",
"pl": "Text field",
"ru": "Text field",
"sc": "Text field",
"tc": "Text field",
"th": "Text field",
"tr": "Text field",
"ua": "Text field",
"vn": "Text field"
},
"ERROR_MESSAGE": {
"ar": "Text field",
"br": "Text field",
"de": "Text field",
"en": "Text field",
"fr": "Text field",
"id": "Text field",
"it": "Text field",
"ja": "Text field",
"la": "Text field",
"ms": "Text field",
"pl": "Text field",
"ru": "Text field",
"sc": "Text field",
"tc": "Text field",
"th": "Text field",
"tr": "Text field",
"ua": "Text field",
"vn": "Text field"
},
"HELP_MESSAGE": {
"ar": "Text field",
"br": "Text field",
"de": "Text field",
"en": "Text field",
"fr": "Text field",
"id": "Text field",
"it": "Text field",
"ja": "Text field",
"la": "Text field",
"ms": "Text field",
"pl": "Text field",
"ru": "Text field",
"sc": "Text field",
"tc": "Text field",
"th": "Text field",
"tr": "Text field",
"ua": "Text field",
"vn": "Text field"
}
},
"total": 0,
"time": {
"start": 1722114797.9059,
"finish": 1722114797.92375,
"duration": 0.0178542137145996,
"processing": 0.000695943832397461,
"date_start": "2024-07-27T21:13:17+00:00",
"date_finish": "2024-07-27T21:13:17+00:00",
"operating_reset_at": 1722115397,
"operating": 0
}
}
```

View File

@ -0,0 +1,157 @@
---
sidebar_position: 1
---
# Get list of custom task fields
Gets list of custom task fields
`Function GetCustomTaskFieldsList(Val URL, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| 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: [task.item.userfield.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/getlist.php)
:::
<br/>
```bsl title="Code example"
URL = FunctionParameters["Bitrix24_URL"];
Result = OPI_Bitrix24.GetCustomTaskFieldsList(URL);
URL = FunctionParameters["Bitrix24_UR"];
Token = FunctionParameters["Bitrix24_Token"];
Result = OPI_Bitrix24.GetCustomTaskFieldsList(URL);
```
```sh title="CLI command example"
oint bitrix24 GetCustomTaskFieldsList --url %url% --token %token%
```
```json title="Result"
{
"result": [
{
"ID": "11",
"ENTITY_ID": "TASKS_TASK",
"FIELD_NAME": "UF_CRM_TASK",
"USER_TYPE_ID": "crm",
"XML_ID": null,
"SORT": "100",
"MULTIPLE": "Y",
"MANDATORY": "N",
"SHOW_FILTER": "N",
"SHOW_IN_LIST": "Y",
"EDIT_IN_LIST": "Y",
"IS_SEARCHABLE": "N",
"SETTINGS": {
"LEAD": "Y",
"CONTACT": "Y",
"COMPANY": "Y",
"DEAL": "Y",
"ORDER": "Y",
"SMART_INVOICE": "Y"
}
},
{
"ID": "101",
"ENTITY_ID": "TASKS_TASK",
"FIELD_NAME": "UF_TASK_WEBDAV_FILES",
"USER_TYPE_ID": "disk_file",
"XML_ID": "TASK_WEBDAV_FILES",
"SORT": "100",
"MULTIPLE": "Y",
"MANDATORY": "N",
"SHOW_FILTER": "N",
"SHOW_IN_LIST": "Y",
"EDIT_IN_LIST": "Y",
"IS_SEARCHABLE": "Y",
"SETTINGS": []
},
{
"ID": "117",
"ENTITY_ID": "TASKS_TASK",
"FIELD_NAME": "UF_MAIL_MESSAGE",
"USER_TYPE_ID": "mail_message",
"XML_ID": "",
"SORT": "100",
"MULTIPLE": "N",
"MANDATORY": "N",
"SHOW_FILTER": "N",
"SHOW_IN_LIST": "N",
"EDIT_IN_LIST": "N",
"IS_SEARCHABLE": "N",
"SETTINGS": []
},
{
"ID": "259",
"ENTITY_ID": "TASKS_TASK",
"FIELD_NAME": "UF_BIRTHDAY_FIELD",
"USER_TYPE_ID": "date",
"XML_ID": null,
"SORT": "100",
"MULTIPLE": "N",
"MANDATORY": "N",
"SHOW_FILTER": "N",
"SHOW_IN_LIST": "Y",
"EDIT_IN_LIST": "Y",
"IS_SEARCHABLE": "N",
"SETTINGS": {
"DEFAULT_VALUE": {
"TYPE": "NONE",
"VALUE": ""
}
}
},
{
"ID": "261",
"ENTITY_ID": "TASKS_TASK",
"FIELD_NAME": "UF_TEXT_FIELD",
"USER_TYPE_ID": "string",
"XML_ID": "NEW_TEXT_FIELD",
"SORT": "100",
"MULTIPLE": "N",
"MANDATORY": "N",
"SHOW_FILTER": "N",
"SHOW_IN_LIST": "Y",
"EDIT_IN_LIST": "Y",
"IS_SEARCHABLE": "N",
"SETTINGS": {
"SIZE": 20,
"ROWS": 1,
"REGEXP": "",
"MIN_LENGTH": 0,
"MAX_LENGTH": 0,
"DEFAULT_VALUE": ""
}
}
],
"total": 0,
"time": {
"start": 1722114799.57,
"finish": 1722114799.58769,
"duration": 0.0176839828491211,
"processing": 0.000379085540771484,
"date_start": "2024-07-27T21:13:19+00:00",
"date_finish": "2024-07-27T21:13:19+00:00",
"operating_reset_at": 1722115399,
"operating": 0
}
}
```

View File

@ -0,0 +1,72 @@
---
sidebar_position: 3
---
# Update custom task field
Updates a custom task field data
`Function UpdateCustomTaskField(Val URL, Val FieldID, Val ExternalID = "", Val Title = "", Val Signature = "", Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FieldID | --fieldid | String, Number | Field ID for updating |
| ExternalID | --externalid | String | Text identifier for external integration |
| Title | --title | String | Field title |
| Signature | --label | Structure of KeyAndValue | Form label. Key: en or ru, Value: Lable text |
| 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: [task.item.userfield.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/update.php)
:::
<br/>
```bsl title="Code example"
URL = FunctionParameters["Bitrix24_URL"];
FieldID = FunctionParameters["Bitrix24_HookTaskFieldID"];
Title = "New title";
Result = OPI_Bitrix24.UpdateCustomTaskField(URL, FieldID,, Title);
URL = FunctionParameters["Bitrix24_URL"];
Token = FunctionParameters["Bitrix24_Token"];
FieldID = FunctionParameters["Bitrix24_TaskFieldID"];
ExternalID = "NEW_TEXT_FIELD";
Signature = New Structure("en,ru", "Updated field", "Izmenennoe pole");
Result = OPI_Bitrix24.UpdateCustomTaskField(URL, FieldID, ExternalID,, Signature, Token);
```
```sh title="CLI command example"
oint bitrix24 UpdateCustomTaskField --url %url% --fieldid %fieldid% --externalid %externalid% --title %title% --label %label% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1722114796.23423,
"finish": 1722114796.26623,
"duration": 0.0319931507110596,
"processing": 0.0126721858978271,
"date_start": "2024-07-27T21:13:16+00:00",
"date_finish": "2024-07-27T21:13:16+00:00",
"operating_reset_at": 1722115396,
"operating": 0
}
}
```

View File

@ -0,0 +1,4 @@
{
"label": "Customs tasks fields managment",
"position": "5"
}

View File

@ -0,0 +1,74 @@
---
sidebar_position: 1
---
# Create department
Creates a new department
`Function CreateDepartment(Val URL, Val Name, Val ParentID = "", Val HeadID = "", Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| Name | --title | String | Department name |
| ParentID | --parentid | String, Number | ID of parent department |
| HeadID | --headid | String, Number | ID of department manager |
| 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: [department.add](https://dev.1c-bitrix.ru/rest_help/departments/department_add.php)
:::
<br/>
```bsl title="Code example"
URL = FunctionParameters["Bitrix24_URL"];
Name = "Main department";
ParentID = 1;
Result = OPI_Bitrix24.CreateDepartment(URL, Name, ParentID);
URL = FunctionParameters["Bitrix24_UR"];
Token = FunctionParameters["Bitrix24_Token"];
Name = "Subordinate department";
ParentID = FunctionParameters["Bitrix24_HookDepID"];
HeadID = 1;
Result = OPI_Bitrix24.CreateDepartment(URL, Name, ParentID, HeadID, Token);
```
```sh title="CLI command example"
oint bitrix24 CreateDepartment --url %url% --title %title% --parentid %parentid% --headid %headid% --token %token%
```
```json title="Result"
{
"result": 42,
"time": {
"start": 1722171476.78229,
"finish": 1722171477.19809,
"duration": 0.415800094604492,
"processing": 0.389212131500244,
"date_start": "2024-07-28T12:57:56+00:00",
"date_finish": "2024-07-28T12:57:57+00:00",
"operating_reset_at": 1722172076,
"operating": 0.389190912246704
}
}
```

View File

@ -0,0 +1,66 @@
---
sidebar_position: 4
---
# Delete department
Delets department by ID
`Function DeleteDepartment(Val URL, Val DepartmentID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| DepartmentID | --depid | String, Number | Department ID for deletion |
| 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: [department.delete](https://dev.1c-bitrix.ru/rest_help/departments/department_delete.php)
:::
<br/>
```bsl title="Code example"
URL = FunctionParameters["Bitrix24_URL"];
DepartmentID = FunctionParameters["Bitrix24_DepID"];
Result = OPI_Bitrix24.DeleteDepartment(URL, DepartmentID);
URL = FunctionParameters["Bitrix24_Domain"];
Token = FunctionParameters["Bitrix24_Token"];
DepartmentID = FunctionParameters["Bitrix24_HookDepID"];
Result = OPI_Bitrix24.DeleteDepartment(URL, DepartmentID, Token);
```
```sh title="CLI command example"
oint bitrix24 DeleteDepartment --url %url% --depid %depid% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1722171482.56495,
"finish": 1722171482.65313,
"duration": 0.0881810188293457,
"processing": 0.0624208450317383,
"date_start": "2024-07-28T12:58:02+00:00",
"date_finish": "2024-07-28T12:58:02+00:00",
"operating_reset_at": 1722172082,
"operating": 0
}
}
```

View File

@ -0,0 +1,78 @@
---
sidebar_position: 3
---
# Get departments
Gets a list of departments by ID or filter
`Function GetDepartments(Val URL, Val DepartmentID = "", Val Name = "", Val ParentID = "", Val HeadID = "", Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| DepartmentID | --depid | String, Number | Selection by department ID |
| Name | --title | String | Filter by name |
| ParentID | --parentid | String, Number | Filter by parent ID |
| HeadID | --headid | String, Number | Filter by manager ID |
| 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: [department.get](https://dev.1c-bitrix.ru/rest_help/departments/department_get.php)
:::
<br/>
```bsl title="Code example"
URL = FunctionParameters["Bitrix24_URL"];
DepartmentID = FunctionParameters["Bitrix24_DepID"];
Result = OPI_Bitrix24.GetDepartments(URL, DepartmentID);
URL = FunctionParameters["Bitrix24_Domain"];
Token = FunctionParameters["Bitrix24_Token"];
HeadID = 1;
Result = OPI_Bitrix24.GetDepartments(URL,,,, HeadID, Token);
```
```sh title="CLI command example"
oint bitrix24 GetDepartments --url %url% --depid %depid% --title %title% --parentid %parentid% --headid %headid% --token %token%
```
```json title="Result"
{
"result": [
{
"ID": "42",
"NAME": "Subordinate department",
"SORT": 500,
"PARENT": "40",
"UF_HEAD": "1"
}
],
"total": 1,
"time": {
"start": 1722171478.80371,
"finish": 1722171478.83794,
"duration": 0.034229040145874,
"processing": 0.00419092178344727,
"date_start": "2024-07-28T12:57:58+00:00",
"date_finish": "2024-07-28T12:57:58+00:00",
"operating_reset_at": 1722172078,
"operating": 0
}
}
```

View File

@ -0,0 +1,80 @@
---
sidebar_position: 2
---
# Update department
Update an existing department
`Function UpdateDepartment(Val URL, Val DepartmentID, Val Name = "", Val ParentID = "", Val HeadID = "", Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| DepartmentID | --depid | String, Number | Department ID |
| Name | --title | String | Department name |
| ParentID | --parentid | String, Number | ID of parent department |
| HeadID | --headid | String, Number | ID of department manager |
| 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: [department.update](https://dev.1c-bitrix.ru/rest_help/departments/department_update.php)
:::
<br/>
```bsl title="Code example"
URL = FunctionParameters["Bitrix24_URL"];
DepartmentID = FunctionParameters["Bitrix24_HookDepID"];
ParentID = 7;
Result = OPI_Bitrix24.UpdateDepartment(URL, DepartmentID,, ParentID);
URL = FunctionParameters["Bitrix24_UR"];
Token = FunctionParameters["Bitrix24_Token"];
DepartmentID = FunctionParameters["Bitrix24_DepID"];
Name = "New department";
ParentID = 1;
HeadID = 10;
Result = OPI_Bitrix24.UpdateDepartment(URL
, DepartmentID
, Name
, ParentID
, HeadID
, Token);
```
```sh title="CLI command example"
oint bitrix24 UpdateDepartment --url %url% --depid %depid% --title %title% --parentid %parentid% --headid %headid% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1722171480.45996,
"finish": 1722171480.83957,
"duration": 0.37961220741272,
"processing": 0.347241878509522,
"date_start": "2024-07-28T12:58:00+00:00",
"date_finish": "2024-07-28T12:58:00+00:00",
"operating_reset_at": 1722172080,
"operating": 0.34721302986145
}
}
```

View File

@ -0,0 +1,4 @@
{
"label": "Departments managment",
"position": "16"
}

View File

@ -25,7 +25,7 @@ sidebar_position: 2
<br/>
:::tip
Method at API documentation: [log.blogpost.update](https://dev.1c-bitrix.ru/rest_help/log/log_blogpost_update.php.php)
Method at API documentation: [log.blogpost.update](https://dev.1c-bitrix.ru/rest_help/log/log_blogpost_update.php)
:::
<br/>

View File

@ -1,4 +1,4 @@
{
"label": "File managment",
"position": "11"
"position": "12"
}

View File

@ -1,4 +1,4 @@
{
"label": "Kanban",
"position": "7"
"position": "8"
}

View File

@ -1,4 +1,4 @@
{
"label": "Message management",
"position": "13"
"position": "14"
}

View File

@ -0,0 +1,79 @@
---
sidebar_position: 1
---
# Create personal notification
Creates a personal notification to the user
`Function CreatePersonalNotification(Val URL, Val UserID, Val Text, Val Tag = "", Val Attachments = "", Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| UserID | --user | String, Number | User ID for sending the notification |
| Text | --text | String | Notification text |
| Tag | --tag | String | Uniqueness Tag. If already exist, other notif. will be deleted |
| Attachments | --blocks | Array of Structure | Array of attachments |
| 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: [im.notify.personal.add](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=12129)
:::
<br/>
```bsl title="Code example"
UserID = 1;
URL = FunctionParameters["Bitrix24_URL"];
Text = "Message text";
Image = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg";
File = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx";
Attachments = New Array;
Attachments.Add(OPI_Bitrix24.GetPictureBlock("Image1", Image));
Attachments.Add(OPI_Bitrix24.GetFileBlock("File1.docx", File));
Result = OPI_Bitrix24.CreatePersonalNotification(URL, UserID, Text,,Attachments);
URL = FunctionParameters["Bitrix24_Domain"];
Token = FunctionParameters["Bitrix24_Token"];
Tag = "New";
UserID = 10;
Result = OPI_Bitrix24.CreatePersonalNotification(URL, UserID, Text, Tag,, Token);
```
```sh title="CLI command example"
oint bitrix24 CreatePersonalNotification --url %url% --user %user% --text %text% --tag %tag% --blocks %blocks% --token %token%
```
```json title="Result"
{
"result": 7450,
"time": {
"start": 1722087269.44996,
"finish": 1722087269.50075,
"duration": 0.0507829189300537,
"processing": 0.0262038707733154,
"date_start": "2024-07-27T13:34:29+00:00",
"date_finish": "2024-07-27T13:34:29+00:00",
"operating_reset_at": 1722087869,
"operating": 0
}
}
```

View File

@ -0,0 +1,79 @@
---
sidebar_position: 2
---
# Create system notification
Creates a system notification to the user
`Function CreateSystemNotification(Val URL, Val UserID, Val Text, Val Tag = "", Val Attachments = "", Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| UserID | --user | String, Number | User ID for sending the notification |
| Text | --text | String | Notification text |
| Tag | --tag | String | Uniqueness Tag. If already exist, other notif. will be deleted |
| Attachments | --blocks | Array of Structure | Array of attachments |
| 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: [im.notify.system.add](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=12131)
:::
<br/>
```bsl title="Code example"
UserID = 1;
URL = FunctionParameters["Bitrix24_URL"];
Text = "Message text";
Image = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg";
File = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx";
Attachments = New Array;
Attachments.Add(OPI_Bitrix24.GetPictureBlock("Image1", Image));
Attachments.Add(OPI_Bitrix24.GetFileBlock("File1.docx", File));
Result = OPI_Bitrix24.CreateSystemNotification(URL, UserID, Text,,Attachments);
URL = FunctionParameters["Bitrix24_Domain"];
Token = FunctionParameters["Bitrix24_Token"];
Tag = "New";
UserID = 10;
Result = OPI_Bitrix24.CreateSystemNotification(URL, UserID, Text, Tag,, Token);
```
```sh title="CLI command example"
oint bitrix24 CreateSystemNotification --url %url% --user %user% --text %text% --tag %tag% --blocks %blocks% --token %token%
```
```json title="Result"
{
"result": 7454,
"time": {
"start": 1722087270.72466,
"finish": 1722087270.78145,
"duration": 0.0567879676818848,
"processing": 0.0293958187103272,
"date_start": "2024-07-27T13:34:30+00:00",
"date_finish": "2024-07-27T13:34:30+00:00",
"operating_reset_at": 1722087870,
"operating": 0
}
}
```

View File

@ -0,0 +1,66 @@
---
sidebar_position: 3
---
# Delete notification
Delete notification by ID
`Function DeleteNotification(Val URL, Val NotificationID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| NotificationID | --notif | String, Number | Notification ID |
| 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: [im.notify.delete](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=12133)
:::
<br/>
```bsl title="Code example"
URL = FunctionParameters["Bitrix24_URL"];
NotificationID = FunctionParameters["Bitrix24_PersoalHookNotifyID"];
Result = OPI_Bitrix24.DeleteNotification(URL, NotificationID);
URL = FunctionParameters["Bitrix24_Domain"];
Token = FunctionParameters["Bitrix24_Token"];
NotificationID = FunctionParameters["Bitrix24_PersoalNotifyID"];
Result = OPI_Bitrix24.DeleteNotification(URL, NotificationID, Token);
```
```sh title="CLI command example"
oint bitrix24 DeleteNotification --url %url% --notif %notif% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1722087271.36087,
"finish": 1722087271.39818,
"duration": 0.0373120307922363,
"processing": 0.0110759735107422,
"date_start": "2024-07-27T13:34:31+00:00",
"date_finish": "2024-07-27T13:34:31+00:00",
"operating_reset_at": 1722087871,
"operating": 0
}
}
```

View File

@ -0,0 +1,4 @@
{
"label": "Notifications managment",
"position": "15"
}

View File

@ -1,4 +1,4 @@
{
"label": "Storages managment",
"position": "9"
"position": "10"
}

View File

@ -1,4 +1,4 @@
{
"label": "Tasks checklists managment",
"position": "5"
"position": "6"
}

View File

@ -14,7 +14,7 @@ sidebar_position: 27
| Clear | --empty | Boolean | True > structure with empty valuse, False > field descriptions at values |
Returns: Structure of KeyAndValue - Fields structure
Returns: Structure of KeyAndValue - Fields structure
<br/>

View File

@ -0,0 +1,73 @@
---
sidebar_position: 10
---
# Get timekeeping settings
Gets user timekeeping settings
`Function GetTimekeepingSettings(Val URL, Val UserID = "", Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| UserID | --userid | String, Number | Users ID. Current by default |
| 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: [timeman.settings](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_settings.php)
:::
<br/>
```bsl title="Code example"
URL = FunctionParameters["Bitrix24_URL"];
Result = OPI_Bitrix24.GetTimekeepingSettings(URL);
Hour = 3600;
URL = FunctionParameters["Bitrix24_Domain"];
Token = FunctionParameters["Bitrix24_Token"];
UserID = 1;
Result = OPI_Bitrix24.GetTimekeepingSettings(URL, UserID);
```
```sh title="CLI command example"
oint bitrix24 GetTimekeepingSettings --url %url% --userid %userid% --token %token%
```
```json title="Result"
{
"result": {
"UF_TIMEMAN": true,
"UF_TM_FREE": false,
"UF_TM_MAX_START": "09:15:00",
"UF_TM_MIN_FINISH": "17:45:00",
"UF_TM_MIN_DURATION": "08:00:00",
"UF_TM_ALLOWED_DELTA": "00:15:00",
"ADMIN": true
},
"time": {
"start": 1722332243.86487,
"finish": 1722332243.88732,
"duration": 0.0224521160125732,
"processing": 0.00417494773864746,
"date_start": "2024-07-30T09:37:23+00:00",
"date_finish": "2024-07-30T09:37:23+00:00",
"operating_reset_at": 1722332843,
"operating": 0
}
}
```

View File

@ -0,0 +1,79 @@
---
sidebar_position: 9
---
# Get timekeeping status
Gets user timekeeping status
`Function GetTimekeepingStatus(Val URL, Val UserID = "", Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| UserID | --userid | String, Number | Users ID. Current by default |
| 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: [timeman.status](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_status.php)
:::
<br/>
```bsl title="Code example"
URL = FunctionParameters["Bitrix24_URL"];
Result = OPI_Bitrix24.GetTimekeepingStatus(URL);
Hour = 3600;
URL = FunctionParameters["Bitrix24_Domain"];
Token = FunctionParameters["Bitrix24_Token"];
UserID = 1;
Result = OPI_Bitrix24.GetTimekeepingStatus(URL, UserID);
```
```sh title="CLI command example"
oint bitrix24 GetTimekeepingStatus --url %url% --userid %userid% --token %token%
```
```json title="Result"
{
"result": {
"STATUS": "PAUSED",
"TIME_START": "2024-07-30T07:10:51+00:00",
"TIME_FINISH": "2024-07-30T08:32:00+00:00",
"DURATION": "00:00:00",
"TIME_LEAKS": "00:09:59",
"ACTIVE": false,
"IP_OPEN": "",
"IP_CLOSE": "",
"LAT_OPEN": 0,
"LON_OPEN": 0,
"LAT_CLOSE": 0,
"LON_CLOSE": 0,
"TZ_OFFSET": 10800
},
"time": {
"start": 1722328322.65261,
"finish": 1722328322.6837,
"duration": 0.0310959815979004,
"processing": 0.00899505615234375,
"date_start": "2024-07-30T08:32:02+00:00",
"date_finish": "2024-07-30T08:32:02+00:00",
"operating_reset_at": 1722328922,
"operating": 0
}
}
```

View File

@ -0,0 +1,79 @@
---
sidebar_position: 8
---
# Stop timekeeping
Pauses user timekeeping
`Function PauseTimekeeping(Val URL, Val UserID = "", Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| UserID | --userid | String, Number | Users ID. Current by default |
| 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: [timeman.pause](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_pause.php)
:::
<br/>
```bsl title="Code example"
URL = FunctionParameters["Bitrix24_URL"];
Result = OPI_Bitrix24.PauseTimekeeping(URL);
Hour = 3600;
URL = FunctionParameters["Bitrix24_Domain"];
Token = FunctionParameters["Bitrix24_Token"];
UserID = 1;
Result = OPI_Bitrix24.PauseTimekeeping(URL, UserID);
```
```sh title="CLI command example"
oint bitrix24 PauseTimekeeping --url %url% --userid %userid% --token %token%
```
```json title="Result"
{
"result": {
"STATUS": "PAUSED",
"TIME_START": "2024-07-30T07:10:51+00:00",
"TIME_FINISH": "2024-07-30T08:32:00+00:00",
"DURATION": "00:00:00",
"TIME_LEAKS": "00:09:59",
"ACTIVE": false,
"IP_OPEN": "",
"IP_CLOSE": "",
"LAT_OPEN": 0,
"LON_OPEN": 0,
"LAT_CLOSE": 0,
"LON_CLOSE": 0,
"TZ_OFFSET": 10800
},
"time": {
"start": 1722328320.91942,
"finish": 1722328320.98461,
"duration": 0.0651938915252686,
"processing": 0.0352118015289307,
"date_start": "2024-07-30T08:32:00+00:00",
"date_finish": "2024-07-30T08:32:00+00:00",
"operating_reset_at": 1722328920,
"operating": 0
}
}
```

View File

@ -0,0 +1,83 @@
---
sidebar_position: 6
---
# Start timekeeping
Starts user timekeeping
`Function StartTimekeeping(Val URL, Val UserID = "", Val Time = "", Val Report = "", Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| UserID | --userid | String, Number | Users ID. Current by default |
| Time | --time | Date | Start time. The date must match the current. Current time by default. |
| Report | --report | String | Reason for change. Required when Time is specified and free schedule is disabled |
| 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: [timeman.open](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_open.php)
:::
<br/>
```bsl title="Code example"
URL = FunctionParameters["Bitrix24_URL"];
Result = OPI_Bitrix24.StartTimekeeping(URL);
Hour = 3600;
URL = FunctionParameters["Bitrix24_Domain"];
Token = FunctionParameters["Bitrix24_Token"];
UserID = 1;
Time = OPI_Tools.GetCurrentDate() - Hour;
Report = "Late";
Result = OPI_Bitrix24.StartTimekeeping(URL, UserID, Time, Report, );
```
```sh title="CLI command example"
oint bitrix24 StartTimekeeping --url %url% --userid %userid% --time %time% --report %report% --token %token%
```
```json title="Result"
{
"result": {
"STATUS": "OPENED",
"TIME_START": "2024-07-30T07:10:51+00:00",
"TIME_FINISH": null,
"DURATION": "00:00:00",
"TIME_LEAKS": "00:09:59",
"ACTIVE": false,
"IP_OPEN": "",
"IP_CLOSE": "93.125.42.204",
"LAT_OPEN": 0,
"LON_OPEN": 0,
"LAT_CLOSE": 0,
"LON_CLOSE": 0,
"TZ_OFFSET": 10800
},
"time": {
"start": 1722328319.21856,
"finish": 1722328319.25781,
"duration": 0.0392520427703857,
"processing": 0.014214038848877,
"date_start": "2024-07-30T08:31:59+00:00",
"date_finish": "2024-07-30T08:31:59+00:00",
"operating_reset_at": 1722328919,
"operating": 0.181692123413086
}
}
```

View File

@ -0,0 +1,58 @@
---
sidebar_position: 7
---
# Stop timekeeping
Stops user timekeeping
`Function StopTimekeeping(Val URL, Val UserID = "", Val Time = "", Val Report = "", Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| UserID | --userid | String, Number | Users ID. Current by default |
| Time | --time | Date | Stop time. The date must match the current. Current time by default. |
| Report | --report | String | Reason for change. Required when Time is specified and free schedule is disabled |
| 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: [timeman.close](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_close.php)
:::
<br/>
```bsl title="Code example"
URL = FunctionParameters["Bitrix24_URL"];
Result = OPI_Bitrix24.StopTimekeeping(URL);
URL = FunctionParameters["Bitrix24_Domain"];
Token = FunctionParameters["Bitrix24_Token"];
UserID = 1;
Time = OPI_Tools.GetCurrentDate();
Report = "Time off";
Result = OPI_Bitrix24.StopTimekeeping(URL, UserID, Time, Report, );
```
```sh title="CLI command example"
oint bitrix24 StopTimekeeping --url %url% --userid %userid% --time %time% --report %report% --token %token%
```
```json title="Result"
{
"error": "WRONG_DATETIME_FORMAT",
"error_description": "Wrong datetime format"
}
```

View File

@ -1,4 +1,4 @@
{
"label": "Timekeeping",
"position": "8"
"position": "9"
}

View File

@ -0,0 +1,64 @@
---
sidebar_position: 5
---
# Change user status
Activates or deactivates (fire) the selected user
`Function ChangeUserStatus(Val URL, Val UserID, Val Fire = True, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| UserID | --userid | String, Number | User ID |
| Fire | --fire | Boolean | True > Deactivation, False > Activation |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
```bsl title="Code example"
URL = FunctionParameters["Bitrix24_URL"];
UserID = FunctionParameters["Bitrix24_HookUserID"];
Result = OPI_Bitrix24.ChangeUserStatus(URL, UserID, True);
URL = FunctionParameters["Bitrix24_Domain"];
Token = FunctionParameters["Bitrix24_Token"];
UserID = FunctionParameters["Bitrix24_UserID"];
Result = OPI_Bitrix24.ChangeUserStatus(URL, UserID, True, Token);
```
```sh title="CLI command example"
oint bitrix24 ChangeUserStatus --url %url% --userid %userid% --fire %fire% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1722328399.68494,
"finish": 1722328399.94913,
"duration": 0.264194965362549,
"processing": 0.229634046554565,
"date_start": "2024-07-30T08:33:19+00:00",
"date_finish": "2024-07-30T08:33:19+00:00",
"operating_reset_at": 1722328999,
"operating": 0.5396409034729
}
}
```

View File

@ -0,0 +1,83 @@
---
sidebar_position: 3
---
# Create user
Create new user by fields structure
`Function CreateUser(Val URL, Val FieldsStructure, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FieldsStructure | --fields | Structure of KeyAndValue | New user data. See. GetUserFieldsStructure |
| 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.add](https://dev.1c-bitrix.ru/rest_help/users/user_add.php)
If you want to add an extranet user, you must pass in the fields: EXTRANET: Y and SONET_GROUP_ID: [...]
If you want to add an intranet user, you must pass UF_DEPARTMENT field: [...]
:::
<br/>
```bsl title="Code example"
URL = FunctionParameters["Bitrix24_URL"];
Email = String(New UUID) + "@exepmple.org";
// The full structure can be obtained with the function GetUserFieldsStructure
UserStructure = New Structure;
UserStructure.Insert("EMAIL", Email);
UserStructure.Insert("UF_DEPARTMENT", 7);
Result = OPI_Bitrix24.CreateUser(URL, UserStructure);
URL = FunctionParameters["Bitrix24_URL"];
Token = FunctionParameters["Bitrix24_Token"];
Email = String(New UUID) + "@exepmple.org";
UserStructure = New Structure;
UserStructure.Insert("EMAIL", Email);
UserStructure.Insert("NAME", "Vitaly");
UserStructure.Insert("LAST_NAME", "Alpaca");
UserStructure.Insert("PERSONAL_MOBILE", "88003553535");
UserStructure.Insert("UF_DEPARTMENT", 1);
Result = OPI_Bitrix24.CreateUser(URL, UserStructure, Token);
```
```sh title="CLI command example"
oint bitrix24 CreateUser --url %url% --fields %fields% --token %token%
```
```json title="Result"
{
"result": 60,
"time": {
"start": 1722328388.80414,
"finish": 1722328391.95472,
"duration": 3.15058398246765,
"processing": 3.02733707427978,
"date_start": "2024-07-30T08:33:08+00:00",
"date_finish": "2024-07-30T08:33:11+00:00",
"operating_reset_at": 1722328988,
"operating": 3.0273129940033
}
}
```

View File

@ -0,0 +1,279 @@
---
sidebar_position: 6
---
# 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 | Destination |
|-|-|-|-|
| 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 = FunctionParameters["Bitrix24_URL"];
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 = FunctionParameters["Bitrix24_URL"];
Token = FunctionParameters["Bitrix24_Token"];
FilterStructure = New Structure;
FilterStructure.Insert("UF_DEPARTMENT_NAME", "Bitrix");
Result = OPI_Bitrix24.FindUsers(URL, FilterStructure, Token);
```
```sh title="CLI command example"
oint bitrix24 FindUsers --url %url% --filter %filter% --token %token%
```
```json title="Result"
{
"result": [
{
"ID": "12",
"XML_ID": "56479740",
"ACTIVE": true,
"NAME": "Bay",
"LAST_NAME": "Selonarrend",
"EMAIL": "oarismos@gmail.com",
"LAST_LOGIN": "2024-07-13T07:17:17+00:00",
"DATE_REGISTER": "2024-07-13T00:00:00+00:00",
"IS_ONLINE": "N",
"TIMESTAMP_X": {},
"LAST_ACTIVITY_DATE": {},
"PERSONAL_GENDER": "",
"PERSONAL_BIRTHDAY": "",
"UF_EMPLOYMENT_DATE": "",
"UF_DEPARTMENT": [
1
],
"USER_TYPE": "employee"
},
{
"ID": "18",
"XML_ID": "56701916",
"ACTIVE": true,
"EMAIL": "hey@exepmple.com",
"LAST_LOGIN": "",
"DATE_REGISTER": "2024-07-28T00:00:00+00:00",
"IS_ONLINE": "N",
"TIMESTAMP_X": {},
"PERSONAL_GENDER": "",
"PERSONAL_BIRTHDAY": "",
"UF_EMPLOYMENT_DATE": "",
"UF_DEPARTMENT": [
1
],
"USER_TYPE": "employee"
},
{
"ID": "34",
"XML_ID": "56702240",
"ACTIVE": false,
"EMAIL": "537fafa9-e5ea-4221-bd46-4f6db2609634@exepmple.org",
"LAST_LOGIN": "",
"DATE_REGISTER": "2024-07-28T00:00:00+00:00",
"IS_ONLINE": "N",
"TIMESTAMP_X": {},
"PERSONAL_GENDER": "",
"PERSONAL_BIRTHDAY": "",
"UF_EMPLOYMENT_DATE": "",
"UF_DEPARTMENT": [
1
],
"USER_TYPE": "employee"
},
{
"ID": "38",
"XML_ID": "56702244",
"ACTIVE": false,
"EMAIL": "442145e1-75e4-4c85-ac6d-e4da44c859a8@exepmple.org",
"LAST_LOGIN": "",
"DATE_REGISTER": "2024-07-28T00:00:00+00:00",
"IS_ONLINE": "N",
"TIMESTAMP_X": {},
"PERSONAL_GENDER": "",
"PERSONAL_BIRTHDAY": "",
"UF_EMPLOYMENT_DATE": "",
"UF_DEPARTMENT": [
1
],
"USER_TYPE": "employee"
},
{
"ID": "42",
"XML_ID": "56702314",
"ACTIVE": true,
"EMAIL": "3f70caee-2203-46ec-b53c-24f1c7092056@exepmple.org",
"LAST_LOGIN": "",
"DATE_REGISTER": "2024-07-28T00:00:00+00:00",
"IS_ONLINE": "N",
"TIMESTAMP_X": {},
"PERSONAL_GENDER": "",
"PERSONAL_BIRTHDAY": "",
"UF_EMPLOYMENT_DATE": "",
"UF_DEPARTMENT": [
1
],
"USER_TYPE": "employee"
},
{
"ID": "46",
"XML_ID": "56702336",
"ACTIVE": false,
"EMAIL": "f23e7d22-016d-4711-aa0f-439951951f35@exepmple.org",
"LAST_LOGIN": "",
"DATE_REGISTER": "2024-07-28T00:00:00+00:00",
"IS_ONLINE": "N",
"TIMESTAMP_X": {},
"PERSONAL_GENDER": "",
"PERSONAL_BIRTHDAY": "",
"UF_EMPLOYMENT_DATE": "",
"UF_DEPARTMENT": [
1
],
"USER_TYPE": "employee"
},
{
"ID": "50",
"XML_ID": "56702654",
"ACTIVE": false,
"EMAIL": "360bd8ae-146c-497b-ae87-0699855f21b7@exepmple.org",
"LAST_LOGIN": "",
"DATE_REGISTER": "2024-07-28T00:00:00+00:00",
"IS_ONLINE": "N",
"TIMESTAMP_X": {},
"PERSONAL_GENDER": "",
"PERSONAL_BIRTHDAY": "",
"UF_EMPLOYMENT_DATE": "",
"UF_DEPARTMENT": [
1
],
"USER_TYPE": "employee"
},
{
"ID": "54",
"XML_ID": "56721830",
"ACTIVE": false,
"EMAIL": "15ea8982-762a-44a0-9c53-c97530015c46@exepmple.org",
"LAST_LOGIN": "",
"DATE_REGISTER": "2024-07-29T00:00:00+00:00",
"IS_ONLINE": "N",
"TIMESTAMP_X": {},
"PERSONAL_GENDER": "",
"PERSONAL_BIRTHDAY": "",
"UF_EMPLOYMENT_DATE": "",
"UF_DEPARTMENT": [
1
],
"USER_TYPE": "employee"
},
{
"ID": "1",
"XML_ID": "53818298",
"ACTIVE": true,
"NAME": "Anton",
"LAST_NAME": "Titovets",
"EMAIL": "no-reply@bitrix24.com",
"LAST_LOGIN": "2024-07-30T06:49:41+00:00",
"DATE_REGISTER": "2024-02-10T00:00:00+00:00",
"IS_ONLINE": "N",
"TIME_ZONE_OFFSET": "0",
"TIMESTAMP_X": {},
"LAST_ACTIVITY_DATE": {},
"PERSONAL_GENDER": "",
"PERSONAL_BIRTHDAY": "",
"PERSONAL_PHOTO": "https://cdn-ru.bitrix24.by/b28528874/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg",
"UF_EMPLOYMENT_DATE": "",
"UF_DEPARTMENT": [
1,
50
],
"USER_TYPE": "employee"
},
{
"ID": "10",
"XML_ID": "56016490",
"ACTIVE": true,
"NAME": "Techno",
"LAST_NAME": "Pizza",
"EMAIL": "iscript13@gmail.com",
"LAST_LOGIN": "2024-07-13T14:46:11+00:00",
"DATE_REGISTER": "2024-06-15T00:00:00+00:00",
"IS_ONLINE": "N",
"TIMESTAMP_X": {},
"LAST_ACTIVITY_DATE": {},
"PERSONAL_GENDER": "",
"PERSONAL_BIRTHDAY": "",
"UF_EMPLOYMENT_DATE": "",
"UF_DEPARTMENT": [
1,
50
],
"USER_TYPE": "employee"
},
{
"ID": "60",
"XML_ID": "56731232",
"ACTIVE": true,
"NAME": "Vitaly",
"LAST_NAME": "Alpaca",
"EMAIL": "87394c27-0694-457e-bcc9-39ccf92ffbf7@exepmple.org",
"LAST_LOGIN": "",
"DATE_REGISTER": "2024-07-30T00:00:00+00:00",
"IS_ONLINE": "N",
"TIMESTAMP_X": {},
"PERSONAL_GENDER": "",
"PERSONAL_BIRTHDAY": "",
"PERSONAL_MOBILE": "88003553535",
"UF_EMPLOYMENT_DATE": "",
"UF_DEPARTMENT": [
1
],
"USER_TYPE": "employee"
}
],
"total": 11,
"time": {
"start": 1722328393.63268,
"finish": 1722328393.68509,
"duration": 0.0524110794067383,
"processing": 0.0202820301055908,
"date_start": "2024-07-30T08:33:13+00:00",
"date_finish": "2024-07-30T08:33:13+00:00",
"operating_reset_at": 1722328993,
"operating": 0
}
}
```

View File

@ -0,0 +1,84 @@
---
sidebar_position: 1
---
# Get current user
Get current user data
`Function GetCurrentUser(Val URL, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| 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.current](https://dev.1c-bitrix.ru/rest_help/users/user_current.php)
:::
<br/>
```bsl title="Code example"
URL = FunctionParameters["Bitrix24_URL"];
Result = OPI_Bitrix24.GetCurrentUser(URL);
URL = FunctionParameters["Bitrix24_Domain"];
Token = FunctionParameters["Bitrix24_Token"];
Result = OPI_Bitrix24.GetCurrentUser(URL, Token);
```
```sh title="CLI command example"
oint bitrix24 GetCurrentUser --url %url% --token %token%
```
```json title="Result"
{
"result": {
"ID": "1",
"XML_ID": "53818298",
"ACTIVE": true,
"NAME": "Anton",
"LAST_NAME": "Titovets",
"EMAIL": "no-reply@bitrix24.com",
"LAST_LOGIN": "2024-07-30T06:49:41+00:00",
"DATE_REGISTER": "2024-02-10T00:00:00+00:00",
"IS_ONLINE": "N",
"TIME_ZONE_OFFSET": "0",
"TIMESTAMP_X": "30.07.2024 11:32:54",
"LAST_ACTIVITY_DATE": "2024-07-30 10:04:49",
"PERSONAL_GENDER": "",
"PERSONAL_BIRTHDAY": "",
"PERSONAL_PHOTO": "https://cdn-ru.bitrix24.by/b28528874/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg",
"UF_EMPLOYMENT_DATE": "",
"UF_DEPARTMENT": [
1,
50
]
},
"time": {
"start": 1722328382.88095,
"finish": 1722328382.91677,
"duration": 0.0358180999755859,
"processing": 0.00372004508972168,
"date_start": "2024-07-30T08:33:02+00:00",
"date_finish": "2024-07-30T08:33:02+00:00",
"operating_reset_at": 1722328982,
"operating": 0
}
}
```

View File

@ -0,0 +1,128 @@
---
sidebar_position: 7
---
# Get user fields structure
Gets the field structure for creating or modifying user information
`Function GetUserFieldsStructure(Val URL, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| 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.fields](https://dev.1c-bitrix.ru/rest_help/users/user_fields.php)
:::
<br/>
```bsl title="Code example"
URL = FunctionParameters["Bitrix24_URL"];
Result = OPI_Bitrix24.GetUserFieldsStructure(URL);
URL = FunctionParameters["Bitrix24_Domain"];
Token = FunctionParameters["Bitrix24_Token"];
Result = OPI_Bitrix24.GetUserFieldsStructure(URL, Token);
```
```sh title="CLI command example"
oint bitrix24 GetUserFieldsStructure --url %url% --token %token%
```
```json title="Result"
{
"result": {
"ID": "ID",
"XML_ID": "Innotшнandй toод",
"ACTIVE": "Аtoтandinbutwithть",
"NAME": "Name",
"LAST_NAME": "LastName",
"SECOND_NAME": "Отчеwithтinо",
"TITLE": "User list",
"EMAIL": "E-Mail",
"LAST_LOGIN": "Afterдняя аinторfromацandя",
"DATE_REGISTER": "Date регandwithтрацandand",
"TIME_ZONE": "TIME_ZONE",
"IS_ONLINE": "IS_ONLINE",
"TIME_ZONE_OFFSET": "TIME_ZONE_OFFSET",
"TIMESTAMP_X": "TIMESTAMP_X",
"LAST_ACTIVITY_DATE": "LAST_ACTIVITY_DATE",
"PERSONAL_GENDER": "Toл",
"PERSONAL_PROFESSION": "Профеwithwithandя",
"PERSONAL_WWW": "Домашняя withтранandчtoа",
"PERSONAL_BIRTHDAY": "Date рожденandя",
"PERSONAL_PHOTO": "Photoграфandя",
"PERSONAL_ICQ": "ICQ",
"PERSONAL_PHONE": "Лandчный телефон",
"PERSONAL_FAX": "Фаtowith",
"PERSONAL_MOBILE": "Лandчный мобandльный",
"PERSONAL_PAGER": "Пейджер",
"PERSONAL_STREET": "Улandца прожandinанandя",
"PERSONAL_CITY": "Город прожandinанandя",
"PERSONAL_STATE": "Region / toрай",
"PERSONAL_ZIP": "Toчтоinый andндеtowith",
"PERSONAL_COUNTRY": "Страto",
"PERSONAL_MAILBOX": "Toчтоinый ящandto",
"PERSONAL_NOTES": "Доtoлнandтельные заметtoand",
"WORK_PHONE": "Phone toомпанandand",
"WORK_COMPANY": "Kомпанandя",
"WORK_POSITION": "Shouldwithть",
"WORK_DEPARTMENT": "Отдел",
"WORK_WWW": "Website toомпанandand",
"WORK_FAX": "WORK_FAX",
"WORK_PAGER": "WORK_PAGER",
"WORK_STREET": "WORK_STREET",
"WORK_MAILBOX": "WORK_MAILBOX",
"WORK_CITY": "Город work",
"WORK_STATE": "WORK_STATE",
"WORK_ZIP": "WORK_ZIP",
"WORK_COUNTRY": "WORK_COUNTRY",
"WORK_PROFILE": "WORK_PROFILE",
"WORK_LOGO": "WORK_LOGO",
"WORK_NOTES": "WORK_NOTES",
"UF_SKYPE_LINK": "Link to чат in Skype",
"UF_ZOOM": "Zoom",
"UF_EMPLOYMENT_DATE": "Date прandнятandя to работу",
"UF_TIMEMAN": "Timekeeping",
"UF_DEPARTMENT": "Toдразделенandя",
"UF_INTERESTS": "Andнтереwithы",
"UF_SKILLS": "Nаinыtoand",
"UF_WEB_SITES": "Другandе withайты",
"UF_XING": "Xing",
"UF_LINKEDIN": "LinkedIn",
"UF_FACEBOOK": "Facebook",
"UF_TWITTER": "Twitter",
"UF_SKYPE": "Skype",
"UF_DISTRICT": "Район",
"UF_PHONE_INNER": "Inнутреннandй телефон",
"USER_TYPE": "USER_TYPE"
},
"time": {
"start": 1722328384.61197,
"finish": 1722328384.64683,
"duration": 0.0348641872406006,
"processing": 0.000688076019287109,
"date_start": "2024-07-30T08:33:04+00:00",
"date_finish": "2024-07-30T08:33:04+00:00",
"operating_reset_at": 1722328984,
"operating": 0
}
}
```

View File

@ -0,0 +1,33 @@
---
sidebar_position: 8
---
# Get user filter structure
Returns the field structure for filtering users in the FindUsers method
`Function GetUserFilterStructure(Val Clear = False) Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Clear | --empty | Boolean | True > structure with empty valuse, False > field descriptions at values |
Returns: Structure of KeyAndValue - Fields structure
<br/>
```sh title="CLI command example"
oint bitrix24 GetUserFilterStructure --empty %empty%
```

View File

@ -0,0 +1,88 @@
---
sidebar_position: 2
---
# Get user
Gets user information by ID
`Function GetUser(Val URL, Val UserID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| UserID | --userid | String, Number | User ID |
| 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.get](https://dev.1c-bitrix.ru/rest_help/users/user_get.php)
:::
<br/>
```bsl title="Code example"
URL = FunctionParameters["Bitrix24_URL"];
UserID = FunctionParameters["Bitrix24_HookUserID"];
Result = OPI_Bitrix24.GetUser(URL, UserID);
URL = FunctionParameters["Bitrix24_Domain"];
Token = FunctionParameters["Bitrix24_Token"];
UserID = FunctionParameters["Bitrix24_UserID"];
Result = OPI_Bitrix24.GetUser(URL, UserID, Token);
```
```sh title="CLI command example"
oint bitrix24 GetUser --url %url% --userid %userid% --token %token%
```
```json title="Result"
{
"result": [
{
"ID": "60",
"XML_ID": "56731232",
"ACTIVE": true,
"NAME": "Oleg",
"LAST_NAME": "Lama",
"EMAIL": "804d1dbb-7df4-4245-8266-938fc2541978@exepmple.org",
"LAST_LOGIN": "",
"DATE_REGISTER": "2024-07-30T00:00:00+00:00",
"IS_ONLINE": "N",
"TIMESTAMP_X": {},
"PERSONAL_GENDER": "",
"PERSONAL_BIRTHDAY": "",
"PERSONAL_MOBILE": "88003553535",
"UF_EMPLOYMENT_DATE": "",
"UF_DEPARTMENT": [
7
],
"USER_TYPE": "employee"
}
],
"total": 1,
"time": {
"start": 1722328397.72079,
"finish": 1722328397.76914,
"duration": 0.0483510494232178,
"processing": 0.0120601654052734,
"date_start": "2024-07-30T08:33:17+00:00",
"date_finish": "2024-07-30T08:33:17+00:00",
"operating_reset_at": 1722328997,
"operating": 0
}
}
```

View File

@ -0,0 +1,81 @@
---
sidebar_position: 4
---
# Update user
Updates user data
`Function UpdateUser(Val URL, Val UserID, Val FieldsStructure, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| UserID | --userid | String, Number | User ID |
| FieldsStructure | --fields | Structure of KeyAndValue | New user data. See. GetUserFieldsStructure |
| 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 = FunctionParameters["Bitrix24_URL"];
UserID = FunctionParameters["Bitrix24_HookUserID"];
Email = String(New UUID) + "@exepmple.org";
// The full structure can be obtained with the function GetUserFieldsStructure
UserStructure = New Structure;
UserStructure.Insert("EMAIL", Email);
UserStructure.Insert("UF_DEPARTMENT", 1);
Result = OPI_Bitrix24.UpdateUser(URL, UserID, UserStructure);
URL = FunctionParameters["Bitrix24_Domain"];
Token = FunctionParameters["Bitrix24_Token"];
UserID = FunctionParameters["Bitrix24_UserID"];
Email = String(New UUID) + "@exepmple.org";
UserStructure = New Structure;
UserStructure.Insert("EMAIL", Email);
UserStructure.Insert("NAME", "Oleg");
UserStructure.Insert("LAST_NAME", "Lama");
UserStructure.Insert("UF_DEPARTMENT", 7);
Result = OPI_Bitrix24.UpdateUser(URL, UserID, UserStructure, Token);
```
```sh title="CLI command example"
oint bitrix24 UpdateUser --url %url% --userid %userid% --fields %fields% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1722328395.63697,
"finish": 1722328395.97568,
"duration": 0.338706016540527,
"processing": 0.310076951980591,
"date_start": "2024-07-30T08:33:15+00:00",
"date_finish": "2024-07-30T08:33:15+00:00",
"operating_reset_at": 1722328995,
"operating": 0.310055017471314
}
}
```

View File

@ -0,0 +1,4 @@
{
"label": "Users managment",
"position": "17"
}

View File

@ -16,7 +16,7 @@ sidebar_position: 1
| Detailed | --detail | Boolean | Add information fields for mediafiles |
Returns: Map Of KeyAndValue - serialized JSON response from Dropbox
Returns: Map Of KeyAndValue - serialized JSON response from Dropbox
<br/>

View File

@ -15,7 +15,7 @@ sidebar_position: 3
| Path | --path | String | Path to the object |
Returns: BinaryData - document preview
Returns: BinaryData - document preview
<br/>

View File

@ -17,7 +17,7 @@ sidebar_position: 4
| Overwrite | --overwrite | Boolean | Overwrite file in case of path conflicts |
Returns: Map Of KeyAndValue - serialized JSON response from Dropbox
Returns: Map Of KeyAndValue - serialized JSON response from Dropbox
<br/>

View File

@ -14,7 +14,7 @@ sidebar_position: 1
| Token | --token | String | Bot token |
Returns: Map Of KeyAndValue - Serialized JSON response from Slack
Returns: Map Of KeyAndValue - Serialized JSON response from Slack
<br/>

View File

@ -7,7 +7,7 @@ sidebar_position: 5
`Function SendDocument(Val Token, Val ChatID, Val Text, Val Document, Val Keyboard = "", Val Markup = "Markdown") Export`
`Function SendDocument(Val Token, Val ChatID, Val Text, Val Document, Val Keyboard = "", Val Markup = "Markdown", Val FileName = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
@ -17,6 +17,7 @@ sidebar_position: 5
| Document | --doc | BinaryData,String | Document file |
| Keyboard | --keyboard | String | Keyboard JSON or path to .json |
| Markup | --parsemode | String | Text processing type (HTML, Markdown, MarkdownV2) |
| FileName | --filename | String | Custom displayed file name with extension, if necessary |
Returns: Map Of KeyAndValue - Serialized JSON response from Telegram

View File

@ -23,7 +23,10 @@ sidebar_position: 7
<br/>
:::tip
Map: Key - File, Value - media type
:::
<br/>
```bsl title="Code example"

View File

@ -16,7 +16,7 @@ sidebar_position: 11
| View | --type | String | Upload type (Post, Product, Story, Poll, Other) |
Returns: Map Of KeyAndValue - Serialized JSON response from VK
Returns: Map Of KeyAndValue - Serialized JSON response from VK
<br/>

View File

@ -18,7 +18,7 @@ sidebar_position: 10
| Parameters | --auth | Structure Of String | Authorization JSON or path to .json |
Returns: Map Of KeyAndValue - Serialized JSON response from VK
Returns: Map Of KeyAndValue - Serialized JSON response from VK
<br/>

View File

@ -15,7 +15,7 @@ sidebar_position: 5
| Parameters | --auth | Structure Of String | Authorization JSON or path to .json |
Returns: String - Shortened URL
Returns: String - Shortened URL
<br/>

View File

@ -14,7 +14,7 @@ sidebar_position: 1
| Parameters | --auth | Structure Of String | Authorization JSON or path to .json |
Returns: Map Of KeyAndValue - Serialized JSON response from VK
Returns: Map Of KeyAndValue - Serialized JSON response from VK
<br/>

View File

@ -16,7 +16,7 @@ sidebar_position: 5
| Parameters | --auth | Structure Of String | Authorization JSON or path to .json |
Returns: Map Of KeyAndValue - Serialized JSON response from VK
Returns: Map Of KeyAndValue - Serialized JSON response from VK
<br/>

View File

@ -15,7 +15,7 @@ sidebar_position: 2
| Parameters | --auth | Structure Of String | Authorization JSON or path to .json |
Returns: Map Of KeyAndValue - Serialized JSON response from VK
Returns: Map Of KeyAndValue - Serialized JSON response from VK
<br/>

View File

@ -15,7 +15,7 @@ sidebar_position: 7
| Parameters | --auth | Structure Of String | Authorization JSON or path to .json |
Returns: Map Of KeyAndValue - Serialized JSON response from VK
Returns: Map Of KeyAndValue - Serialized JSON response from VK
<br/>

View File

@ -15,7 +15,7 @@ sidebar_position: 4
| Parameters | --auth | Structure Of String | Authorization JSON or path to .json |
Returns: Map Of KeyAndValue - Serialized JSON response from VK
Returns: Map Of KeyAndValue - Serialized JSON response from VK
<br/>

View File

@ -17,7 +17,7 @@ sidebar_position: 6
| Parameters | --auth | Structure Of String | Authorization JSON or path to .json |
Returns: Map Of KeyAndValue - Serialized JSON response from VK
Returns: Map Of KeyAndValue - Serialized JSON response from VK
<br/>

View File

@ -16,7 +16,7 @@ sidebar_position: 3
| Parameters | --auth | Structure Of String | Authorization JSON or path to .json |
Returns: Map Of KeyAndValue - Serialized JSON response from VK
Returns: Map Of KeyAndValue - Serialized JSON response from VK
<br/>

View File

@ -14,7 +14,7 @@ sidebar_position: 1
| Parameters | --auth | Structure Of String | Authorization JSON or path to .json |
Returns: Map Of KeyAndValue - Serialized JSON response from VK
Returns: Map Of KeyAndValue - Serialized JSON response from VK
<br/>

View File

@ -14,7 +14,7 @@ Getting a link for interactive token retrieval (access_token), which is necessar
| app_id | --app | String, Number | app_id from application settings |
Returns: String - URL to go to in the browser
Returns: String - URL to go to in the browser
<br/>

View File

@ -17,7 +17,7 @@ sidebar_position: 10
| Overwrite | --rewrite | Boolean | Overwrite if a file with the same name already exists |
Returns: Map Of KeyAndValue - serialized JSON response from Yandex
Returns: Map Of KeyAndValue - serialized JSON response from Yandex
<br/>

View File

@ -15,7 +15,7 @@ sidebar_position: 1
| Path | --path | String | Path to the object to be published |
Returns: Map Of KeyAndValue - serialized JSON response from Yandex
Returns: Map Of KeyAndValue - serialized JSON response from Yandex
<br/>

View File

@ -0,0 +1 @@
oint bitrix24 ДобавитьПользовательскоеПолеЗадачи --url %url% --type %type% --fieldname %fieldname% --externalid %externalid% --title %title% --label %label% --token %token%

View File

@ -0,0 +1 @@
oint bitrix24 ЗавершитьУчетВремени --url %url% --userid %userid% --time %time% --report %report% --token %token%

View File

@ -0,0 +1 @@
oint bitrix24 ИзменитьПодразделение --url %url% --depid %depid% --title %title% --parentid %parentid% --headid %headid% --token %token%

View File

@ -0,0 +1 @@
oint bitrix24 ИзменитьПользовательскоеПолеЗадачи --url %url% --fieldid %fieldid% --externalid %externalid% --title %title% --label %label% --token %token%

View File

@ -0,0 +1 @@
oint bitrix24 ИзменитьПользователя --url %url% --userid %userid% --fields %fields% --token %token%

View File

@ -0,0 +1 @@
oint bitrix24 ИзменитьСтатусПользователя --url %url% --userid %userid% --fire %fire% --token %token%

View File

@ -0,0 +1 @@
oint bitrix24 НайтиПользователей --url %url% --filter %filter% --token %token%

View File

@ -0,0 +1 @@
oint bitrix24 НачатьУчетВремени --url %url% --userid %userid% --time %time% --report %report% --token %token%

View File

@ -0,0 +1 @@
oint bitrix24 ПолучитьНастройкиУчетаВремени --url %url% --userid %userid% --token %token%

View File

@ -0,0 +1 @@
oint bitrix24 ПолучитьПодразделения --url %url% --depid %depid% --title %title% --parentid %parentid% --headid %headid% --token %token%

View File

@ -0,0 +1 @@
oint bitrix24 ПолучитьПользователей --url %url% --users %users% --token %token%

View File

@ -0,0 +1 @@
oint bitrix24 ПолучитьПользовательскоеПолеЗадачи --url %url% --fieldid %fieldid% --token %token%

View File

@ -0,0 +1 @@
oint bitrix24 ПолучитьПользователя --url %url% --userid %userid% --token %token%

View File

@ -0,0 +1 @@
oint bitrix24 ПолучитьСписокПользовательскихПолейЗадачи --url %url% --token %token%

View File

@ -0,0 +1 @@
oint bitrix24 ПолучитьСтатусПользователя --url %url% --token %token%

View File

@ -0,0 +1 @@
oint bitrix24 ПолучитьСтатусУчетаВремени --url %url% --userid %userid% --token %token%

View File

@ -0,0 +1 @@
oint bitrix24 ПолучитьСтруктуруФильтраПользователей --empty %empty%

View File

@ -0,0 +1 @@
oint bitrix24 ПолучитьСтурктуруПользователя --url %url% --token %token%

Some files were not shown because too many files have changed in this diff Show More