diff --git a/docs/en/md/Airtable/Comment-management/Delete-comment.md b/docs/en/md/Airtable/Comment-management/Delete-comment.md index eb44f8446..389b42fef 100644 --- a/docs/en/md/Airtable/Comment-management/Delete-comment.md +++ b/docs/en/md/Airtable/Comment-management/Delete-comment.md @@ -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
diff --git a/docs/en/md/Airtable/Working-with-databases/Get-list-of-bases.md b/docs/en/md/Airtable/Working-with-databases/Get-list-of-bases.md index c9b1a726b..96eeb7739 100644 --- a/docs/en/md/Airtable/Working-with-databases/Get-list-of-bases.md +++ b/docs/en/md/Airtable/Working-with-databases/Get-list-of-bases.md @@ -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
diff --git a/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-filter-structure.md b/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-filter-structure.md index 4e2b4f684..2e914652c 100644 --- a/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-filter-structure.md +++ b/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-filter-structure.md @@ -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
diff --git a/docs/en/md/Bitrix24/Catalogs-managment/_category_.json b/docs/en/md/Bitrix24/Catalogs-managment/_category_.json index cf7eaa2f0..88c1ceb5e 100644 --- a/docs/en/md/Bitrix24/Catalogs-managment/_category_.json +++ b/docs/en/md/Bitrix24/Catalogs-managment/_category_.json @@ -1,4 +1,4 @@ { "label": "Catalogs managment", -"position": "10" +"position": "11" } \ No newline at end of file diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Add-users-to-chat.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Add-users-to-chat.md index 1ee7271ae..dc497f626 100644 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Add-users-to-chat.md +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Add-users-to-chat.md @@ -1,5 +1,5 @@ --- -sidebar_position: 4 +sidebar_position: 5 --- # Add users to chat diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-color.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-color.md index c6334aea9..adda0c63c 100644 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-color.md +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-color.md @@ -1,5 +1,5 @@ --- -sidebar_position: 7 +sidebar_position: 8 --- # Change chat color diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-owner.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-owner.md index cbed7a6a8..795d47294 100644 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-owner.md +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-owner.md @@ -1,5 +1,5 @@ --- -sidebar_position: 9 +sidebar_position: 10 --- # Change chat owner diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-picture.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-picture.md index 8394e6509..de830bea6 100644 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-picture.md +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-picture.md @@ -1,5 +1,5 @@ --- -sidebar_position: 8 +sidebar_position: 9 --- # Change chat picture diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-title.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-title.md index b0458aa55..15a90b683 100644 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-title.md +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-title.md @@ -1,5 +1,5 @@ --- -sidebar_position: 6 +sidebar_position: 7 --- # Change chat title diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Delete-user-from-chat.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Delete-user-from-chat.md index 481fde43b..d9c2666f1 100644 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Delete-user-from-chat.md +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Delete-user-from-chat.md @@ -1,5 +1,5 @@ --- -sidebar_position: 5 +sidebar_position: 6 --- # Delete user from chat diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Disable-chat-notifications.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Disable-chat-notifications.md index 2103795e8..b240a2d82 100644 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Disable-chat-notifications.md +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Disable-chat-notifications.md @@ -1,5 +1,5 @@ --- -sidebar_position: 10 +sidebar_position: 11 --- # Disable chat notifications diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Enable-chat-notifications.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Enable-chat-notifications.md index ded2119d2..205c06004 100644 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Enable-chat-notifications.md +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Enable-chat-notifications.md @@ -1,5 +1,5 @@ --- -sidebar_position: 11 +sidebar_position: 12 --- # Enable chat notifications diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-files-folder.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-files-folder.md index 8ca70abc5..6be6b675b 100644 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-files-folder.md +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-files-folder.md @@ -1,5 +1,5 @@ --- -sidebar_position: 17 +sidebar_position: 20 --- # Get chat files folder diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-members-list.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-members-list.md index 25ac302e2..0c2f8efde 100644 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-members-list.md +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-members-list.md @@ -1,5 +1,5 @@ --- -sidebar_position: 14 +sidebar_position: 15 --- # Get chat members list diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-messages-list.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-messages-list.md index 7f3cf9cc3..9edc73eb9 100644 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-messages-list.md +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-messages-list.md @@ -1,5 +1,5 @@ --- -sidebar_position: 12 +sidebar_position: 13 --- # Get chat messages list diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-structure.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-structure.md index 4de9bebd6..c231d9a94 100644 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-structure.md +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-structure.md @@ -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
diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-dialog.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-dialog.md index c98118077..8340cc939 100644 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-dialog.md +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-dialog.md @@ -1,5 +1,5 @@ --- -sidebar_position: 13 +sidebar_position: 14 --- # Get dialog diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-user-status.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-user-status.md new file mode 100644 index 000000000..53412d8d0 --- /dev/null +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-user-status.md @@ -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 + +
+ +:::tip +Method at API documentation: [im.user.status.get](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11497) +::: +
+ + +```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." +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-users.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-users.md new file mode 100644 index 000000000..a09c42098 --- /dev/null +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-users.md @@ -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 + +
+ +:::tip +Method at API documentation: [im.user.list.get ](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11493) +::: +
+ + +```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 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Read-all.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Read-all.md index b69b4cae2..1192140f3 100644 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Read-all.md +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Read-all.md @@ -1,5 +1,5 @@ --- -sidebar_position: 16 +sidebar_position: 19 --- # Read all diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Send-writing-notification.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Send-writing-notification.md index 7555cfebe..e18d47dd3 100644 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Send-writing-notification.md +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Send-writing-notification.md @@ -1,5 +1,5 @@ --- -sidebar_position: 15 +sidebar_position: 16 --- # Send write notification diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Set-user-status.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Set-user-status.md new file mode 100644 index 000000000..462571416 --- /dev/null +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Set-user-status.md @@ -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 + +
+ +:::tip +Method at API documentation: [im.user.status.set](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11499) +::: +
+ + +```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 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/_category_.json b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/_category_.json index 92a74ab61..7354343d5 100644 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/_category_.json +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/_category_.json @@ -1,4 +1,4 @@ { "label": "Chats and dialogs managment", -"position": "12" +"position": "13" } \ No newline at end of file diff --git a/docs/en/md/Bitrix24/Comments-and-results-managment/Get-comment-structure.md b/docs/en/md/Bitrix24/Comments-and-results-managment/Get-comment-structure.md index 4ff04b14a..80d08dc8a 100644 --- a/docs/en/md/Bitrix24/Comments-and-results-managment/Get-comment-structure.md +++ b/docs/en/md/Bitrix24/Comments-and-results-managment/Get-comment-structure.md @@ -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
diff --git a/docs/en/md/Bitrix24/Comments-and-results-managment/_category_.json b/docs/en/md/Bitrix24/Comments-and-results-managment/_category_.json index b7e39f228..6f4770694 100644 --- a/docs/en/md/Bitrix24/Comments-and-results-managment/_category_.json +++ b/docs/en/md/Bitrix24/Comments-and-results-managment/_category_.json @@ -1,4 +1,4 @@ { "label": "Comments and results managment", -"position": "6" +"position": "7" } \ No newline at end of file diff --git a/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Add-custom-task-field.md b/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Add-custom-task-field.md new file mode 100644 index 000000000..073151b33 --- /dev/null +++ b/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Add-custom-task-field.md @@ -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 + +
+ +:::tip +Method at API documentation: [task.item.userfield.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/add.php) +::: +
+ + +```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 + } +} +``` diff --git a/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Delete-custom-task-field.md b/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Delete-custom-task-field.md new file mode 100644 index 000000000..b7c544d37 --- /dev/null +++ b/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Delete-custom-task-field.md @@ -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 + +
+ +:::tip +Method at API documentation: [task.item.userfield.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/delete.php) +::: +
+ + +```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 + } +} +``` diff --git a/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-field.md b/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-field.md new file mode 100644 index 000000000..a12b49265 --- /dev/null +++ b/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-field.md @@ -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 + +
+ +:::tip +Method at API documentation: [task.item.userfield.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/get.php) +::: +
+ + +```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 + } +} +``` diff --git a/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-fields-list.md b/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-fields-list.md new file mode 100644 index 000000000..de3ef5309 --- /dev/null +++ b/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-fields-list.md @@ -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 + +
+ +:::tip +Method at API documentation: [task.item.userfield.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/getlist.php) +::: +
+ + +```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 + } +} +``` diff --git a/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Update-custom-task-field.md b/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Update-custom-task-field.md new file mode 100644 index 000000000..8b04ea68d --- /dev/null +++ b/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Update-custom-task-field.md @@ -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 + +
+ +:::tip +Method at API documentation: [task.item.userfield.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/update.php) +::: +
+ + +```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 + } +} +``` diff --git a/docs/en/md/Bitrix24/Customs-tasks-fields-managment/_category_.json b/docs/en/md/Bitrix24/Customs-tasks-fields-managment/_category_.json new file mode 100644 index 000000000..f7525d790 --- /dev/null +++ b/docs/en/md/Bitrix24/Customs-tasks-fields-managment/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Customs tasks fields managment", +"position": "5" +} \ No newline at end of file diff --git a/docs/en/md/Bitrix24/Departments-managment/Create-department.md b/docs/en/md/Bitrix24/Departments-managment/Create-department.md new file mode 100644 index 000000000..fe8395ec7 --- /dev/null +++ b/docs/en/md/Bitrix24/Departments-managment/Create-department.md @@ -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 + +
+ +:::tip +Method at API documentation: [department.add](https://dev.1c-bitrix.ru/rest_help/departments/department_add.php) +::: +
+ + +```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 + } +} +``` diff --git a/docs/en/md/Bitrix24/Departments-managment/Delete-department.md b/docs/en/md/Bitrix24/Departments-managment/Delete-department.md new file mode 100644 index 000000000..0ed525100 --- /dev/null +++ b/docs/en/md/Bitrix24/Departments-managment/Delete-department.md @@ -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 + +
+ +:::tip +Method at API documentation: [department.delete](https://dev.1c-bitrix.ru/rest_help/departments/department_delete.php) +::: +
+ + +```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 + } +} +``` diff --git a/docs/en/md/Bitrix24/Departments-managment/Get-departments.md b/docs/en/md/Bitrix24/Departments-managment/Get-departments.md new file mode 100644 index 000000000..1aba7369b --- /dev/null +++ b/docs/en/md/Bitrix24/Departments-managment/Get-departments.md @@ -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 + +
+ +:::tip +Method at API documentation: [department.get](https://dev.1c-bitrix.ru/rest_help/departments/department_get.php) +::: +
+ + +```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 + } +} +``` diff --git a/docs/en/md/Bitrix24/Departments-managment/Update-department.md b/docs/en/md/Bitrix24/Departments-managment/Update-department.md new file mode 100644 index 000000000..32bde977e --- /dev/null +++ b/docs/en/md/Bitrix24/Departments-managment/Update-department.md @@ -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 + +
+ +:::tip +Method at API documentation: [department.update](https://dev.1c-bitrix.ru/rest_help/departments/department_update.php) +::: +
+ + +```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 + } +} +``` diff --git a/docs/en/md/Bitrix24/Departments-managment/_category_.json b/docs/en/md/Bitrix24/Departments-managment/_category_.json new file mode 100644 index 000000000..d12356505 --- /dev/null +++ b/docs/en/md/Bitrix24/Departments-managment/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Departments managment", +"position": "16" +} \ No newline at end of file diff --git a/docs/en/md/Bitrix24/Feed-posts-managment/Update-post.md b/docs/en/md/Bitrix24/Feed-posts-managment/Update-post.md index 345499841..19e9c9cde 100644 --- a/docs/en/md/Bitrix24/Feed-posts-managment/Update-post.md +++ b/docs/en/md/Bitrix24/Feed-posts-managment/Update-post.md @@ -25,7 +25,7 @@ sidebar_position: 2
:::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) :::
diff --git a/docs/en/md/Bitrix24/File-managment/_category_.json b/docs/en/md/Bitrix24/File-managment/_category_.json index aacb9c020..823ac6799 100644 --- a/docs/en/md/Bitrix24/File-managment/_category_.json +++ b/docs/en/md/Bitrix24/File-managment/_category_.json @@ -1,4 +1,4 @@ { "label": "File managment", -"position": "11" +"position": "12" } \ No newline at end of file diff --git a/docs/en/md/Bitrix24/Kanban/_category_.json b/docs/en/md/Bitrix24/Kanban/_category_.json index bdcf39174..8f9359293 100644 --- a/docs/en/md/Bitrix24/Kanban/_category_.json +++ b/docs/en/md/Bitrix24/Kanban/_category_.json @@ -1,4 +1,4 @@ { "label": "Kanban", -"position": "7" +"position": "8" } \ No newline at end of file diff --git a/docs/en/md/Bitrix24/Message-management/_category_.json b/docs/en/md/Bitrix24/Message-management/_category_.json index 15858a40d..4de7ed22a 100644 --- a/docs/en/md/Bitrix24/Message-management/_category_.json +++ b/docs/en/md/Bitrix24/Message-management/_category_.json @@ -1,4 +1,4 @@ { "label": "Message management", -"position": "13" +"position": "14" } \ No newline at end of file diff --git a/docs/en/md/Bitrix24/Notifications-managment/Create-personal-notification.md b/docs/en/md/Bitrix24/Notifications-managment/Create-personal-notification.md new file mode 100644 index 000000000..8007c1370 --- /dev/null +++ b/docs/en/md/Bitrix24/Notifications-managment/Create-personal-notification.md @@ -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 + +
+ +:::tip +Method at API documentation: [im.notify.personal.add](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=12129) +::: +
+ + +```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 + } +} +``` diff --git a/docs/en/md/Bitrix24/Notifications-managment/Create-system-notification.md b/docs/en/md/Bitrix24/Notifications-managment/Create-system-notification.md new file mode 100644 index 000000000..a91ea785b --- /dev/null +++ b/docs/en/md/Bitrix24/Notifications-managment/Create-system-notification.md @@ -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 + +
+ +:::tip +Method at API documentation: [im.notify.system.add](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=12131) +::: +
+ + +```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 + } +} +``` diff --git a/docs/en/md/Bitrix24/Notifications-managment/Delete-notification.md b/docs/en/md/Bitrix24/Notifications-managment/Delete-notification.md new file mode 100644 index 000000000..6398172fc --- /dev/null +++ b/docs/en/md/Bitrix24/Notifications-managment/Delete-notification.md @@ -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 + +
+ +:::tip +Method at API documentation: [im.notify.delete](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=12133) +::: +
+ + +```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 + } +} +``` diff --git a/docs/en/md/Bitrix24/Notifications-managment/_category_.json b/docs/en/md/Bitrix24/Notifications-managment/_category_.json new file mode 100644 index 000000000..3348abe4d --- /dev/null +++ b/docs/en/md/Bitrix24/Notifications-managment/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Notifications managment", +"position": "15" +} \ No newline at end of file diff --git a/docs/en/md/Bitrix24/Storages-managment/_category_.json b/docs/en/md/Bitrix24/Storages-managment/_category_.json index f70c92fb1..090c34f6c 100644 --- a/docs/en/md/Bitrix24/Storages-managment/_category_.json +++ b/docs/en/md/Bitrix24/Storages-managment/_category_.json @@ -1,4 +1,4 @@ { "label": "Storages managment", -"position": "9" +"position": "10" } \ No newline at end of file diff --git a/docs/en/md/Bitrix24/Tasks-checklists-managment/_category_.json b/docs/en/md/Bitrix24/Tasks-checklists-managment/_category_.json index 9bee02cfc..f6775ba4b 100644 --- a/docs/en/md/Bitrix24/Tasks-checklists-managment/_category_.json +++ b/docs/en/md/Bitrix24/Tasks-checklists-managment/_category_.json @@ -1,4 +1,4 @@ { "label": "Tasks checklists managment", -"position": "5" +"position": "6" } \ No newline at end of file diff --git a/docs/en/md/Bitrix24/Tasks-managment/Get-tasks-filter-structure.md b/docs/en/md/Bitrix24/Tasks-managment/Get-tasks-filter-structure.md index ae83963e0..4e6862aab 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Get-tasks-filter-structure.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Get-tasks-filter-structure.md @@ -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
diff --git a/docs/en/md/Bitrix24/Timekeeping/Get-timekeeping-settings.md b/docs/en/md/Bitrix24/Timekeeping/Get-timekeeping-settings.md new file mode 100644 index 000000000..bb788da01 --- /dev/null +++ b/docs/en/md/Bitrix24/Timekeeping/Get-timekeeping-settings.md @@ -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 + +
+ +:::tip +Method at API documentation: [timeman.settings](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_settings.php) +::: +
+ + +```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 + } +} +``` diff --git a/docs/en/md/Bitrix24/Timekeeping/Get-timekeeping-status.md b/docs/en/md/Bitrix24/Timekeeping/Get-timekeeping-status.md new file mode 100644 index 000000000..adf70cb91 --- /dev/null +++ b/docs/en/md/Bitrix24/Timekeeping/Get-timekeeping-status.md @@ -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 + +
+ +:::tip +Method at API documentation: [timeman.status](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_status.php) +::: +
+ + +```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 + } +} +``` diff --git a/docs/en/md/Bitrix24/Timekeeping/Pause-timekeeping.md b/docs/en/md/Bitrix24/Timekeeping/Pause-timekeeping.md new file mode 100644 index 000000000..d3131589a --- /dev/null +++ b/docs/en/md/Bitrix24/Timekeeping/Pause-timekeeping.md @@ -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 + +
+ +:::tip +Method at API documentation: [timeman.pause](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_pause.php) +::: +
+ + +```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 + } +} +``` diff --git a/docs/en/md/Bitrix24/Timekeeping/Start-timekeeping.md b/docs/en/md/Bitrix24/Timekeeping/Start-timekeeping.md new file mode 100644 index 000000000..0071b7c99 --- /dev/null +++ b/docs/en/md/Bitrix24/Timekeeping/Start-timekeeping.md @@ -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 + +
+ +:::tip +Method at API documentation: [timeman.open](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_open.php) +::: +
+ + +```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 + } +} +``` diff --git a/docs/en/md/Bitrix24/Timekeeping/Stop-timekeeping.md b/docs/en/md/Bitrix24/Timekeeping/Stop-timekeeping.md new file mode 100644 index 000000000..cb9aa3ebf --- /dev/null +++ b/docs/en/md/Bitrix24/Timekeeping/Stop-timekeeping.md @@ -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 + +
+ +:::tip +Method at API documentation: [timeman.close](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_close.php) +::: +
+ + +```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" +} +``` diff --git a/docs/en/md/Bitrix24/Timekeeping/_category_.json b/docs/en/md/Bitrix24/Timekeeping/_category_.json index 3486053d6..1457881b6 100644 --- a/docs/en/md/Bitrix24/Timekeeping/_category_.json +++ b/docs/en/md/Bitrix24/Timekeeping/_category_.json @@ -1,4 +1,4 @@ { "label": "Timekeeping", -"position": "8" +"position": "9" } \ No newline at end of file diff --git a/docs/en/md/Bitrix24/Users-managment/Change-user-status.md b/docs/en/md/Bitrix24/Users-managment/Change-user-status.md new file mode 100644 index 000000000..9cec86c37 --- /dev/null +++ b/docs/en/md/Bitrix24/Users-managment/Change-user-status.md @@ -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 + +
+ + + + +```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 + } +} +``` diff --git a/docs/en/md/Bitrix24/Users-managment/Create-user.md b/docs/en/md/Bitrix24/Users-managment/Create-user.md new file mode 100644 index 000000000..057b1bfd1 --- /dev/null +++ b/docs/en/md/Bitrix24/Users-managment/Create-user.md @@ -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 + +
+ +:::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: [...] +::: +
+ + +```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 + } +} +``` diff --git a/docs/en/md/Bitrix24/Users-managment/Find-users.md b/docs/en/md/Bitrix24/Users-managment/Find-users.md new file mode 100644 index 000000000..ed7adadec --- /dev/null +++ b/docs/en/md/Bitrix24/Users-managment/Find-users.md @@ -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 + +
+ +:::tip +Method at API documentation: [user.update](https://dev.1c-bitrix.ru/rest_help/users/user_update.php) +::: +
+ + +```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 + } +} +``` diff --git a/docs/en/md/Bitrix24/Users-managment/Get-current-user.md b/docs/en/md/Bitrix24/Users-managment/Get-current-user.md new file mode 100644 index 000000000..63d397214 --- /dev/null +++ b/docs/en/md/Bitrix24/Users-managment/Get-current-user.md @@ -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 + +
+ +:::tip +Method at API documentation: [user.current](https://dev.1c-bitrix.ru/rest_help/users/user_current.php) +::: +
+ + +```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 + } +} +``` diff --git a/docs/en/md/Bitrix24/Users-managment/Get-user-fields-structure.md b/docs/en/md/Bitrix24/Users-managment/Get-user-fields-structure.md new file mode 100644 index 000000000..febc62c6e --- /dev/null +++ b/docs/en/md/Bitrix24/Users-managment/Get-user-fields-structure.md @@ -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 + +
+ +:::tip +Method at API documentation: [user.fields](https://dev.1c-bitrix.ru/rest_help/users/user_fields.php) +::: +
+ + +```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 + } +} +``` diff --git a/docs/en/md/Bitrix24/Users-managment/Get-user-filter-structure.md b/docs/en/md/Bitrix24/Users-managment/Get-user-filter-structure.md new file mode 100644 index 000000000..854e872a1 --- /dev/null +++ b/docs/en/md/Bitrix24/Users-managment/Get-user-filter-structure.md @@ -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 + +
+ + + + + + + +```sh title="CLI command example" + +oint bitrix24 GetUserFilterStructure --empty %empty% + +``` + + diff --git a/docs/en/md/Bitrix24/Users-managment/Get-user.md b/docs/en/md/Bitrix24/Users-managment/Get-user.md new file mode 100644 index 000000000..a97a4a5a4 --- /dev/null +++ b/docs/en/md/Bitrix24/Users-managment/Get-user.md @@ -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 + +
+ +:::tip +Method at API documentation: [user.get](https://dev.1c-bitrix.ru/rest_help/users/user_get.php) +::: +
+ + +```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 + } +} +``` diff --git a/docs/en/md/Bitrix24/Users-managment/Update-user.md b/docs/en/md/Bitrix24/Users-managment/Update-user.md new file mode 100644 index 000000000..534d986df --- /dev/null +++ b/docs/en/md/Bitrix24/Users-managment/Update-user.md @@ -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 + +
+ +:::tip +Method at API documentation: [user.update](https://dev.1c-bitrix.ru/rest_help/users/user_update.php) +::: +
+ + +```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 + } +} +``` diff --git a/docs/en/md/Bitrix24/Users-managment/_category_.json b/docs/en/md/Bitrix24/Users-managment/_category_.json new file mode 100644 index 000000000..86d79ca0a --- /dev/null +++ b/docs/en/md/Bitrix24/Users-managment/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Users managment", +"position": "17" +} \ No newline at end of file diff --git a/docs/en/md/Dropbox/File-and-directory-management/Get-object-information.md b/docs/en/md/Dropbox/File-and-directory-management/Get-object-information.md index d41f6fb80..bd38e0e55 100644 --- a/docs/en/md/Dropbox/File-and-directory-management/Get-object-information.md +++ b/docs/en/md/Dropbox/File-and-directory-management/Get-object-information.md @@ -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
diff --git a/docs/en/md/Dropbox/File-and-directory-management/Get-preview.md b/docs/en/md/Dropbox/File-and-directory-management/Get-preview.md index e63e77609..8dae2611d 100644 --- a/docs/en/md/Dropbox/File-and-directory-management/Get-preview.md +++ b/docs/en/md/Dropbox/File-and-directory-management/Get-preview.md @@ -15,7 +15,7 @@ sidebar_position: 3 | Path | --path | String | Path to the object | - Returns: BinaryData - document preview + Returns: BinaryData - document preview
diff --git a/docs/en/md/Dropbox/File-and-directory-management/Upload-file.md b/docs/en/md/Dropbox/File-and-directory-management/Upload-file.md index 8b638f53d..ee57ac8df 100644 --- a/docs/en/md/Dropbox/File-and-directory-management/Upload-file.md +++ b/docs/en/md/Dropbox/File-and-directory-management/Upload-file.md @@ -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
diff --git a/docs/en/md/Slack/Management-and-settings/Get-bot-information.md b/docs/en/md/Slack/Management-and-settings/Get-bot-information.md index baf11f54a..2108ada24 100644 --- a/docs/en/md/Slack/Management-and-settings/Get-bot-information.md +++ b/docs/en/md/Slack/Management-and-settings/Get-bot-information.md @@ -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
diff --git a/docs/en/md/Telegram/Data-sending/Send-document.md b/docs/en/md/Telegram/Data-sending/Send-document.md index 87a80d933..025a31b1e 100644 --- a/docs/en/md/Telegram/Data-sending/Send-document.md +++ b/docs/en/md/Telegram/Data-sending/Send-document.md @@ -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 diff --git a/docs/en/md/Telegram/Data-sending/Send-media-group.md b/docs/en/md/Telegram/Data-sending/Send-media-group.md index d0d4eb131..0b7a21270 100644 --- a/docs/en/md/Telegram/Data-sending/Send-media-group.md +++ b/docs/en/md/Telegram/Data-sending/Send-media-group.md @@ -23,7 +23,10 @@ sidebar_position: 7
- +:::tip +Map: Key - File, Value - media type +::: +
```bsl title="Code example" diff --git a/docs/en/md/VK/Community-managment/Upload-photo-to-server.md b/docs/en/md/VK/Community-managment/Upload-photo-to-server.md index 786c19113..537ab1fa6 100644 --- a/docs/en/md/VK/Community-managment/Upload-photo-to-server.md +++ b/docs/en/md/VK/Community-managment/Upload-photo-to-server.md @@ -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
diff --git a/docs/en/md/VK/Community-managment/Upload-video-to-server.md b/docs/en/md/VK/Community-managment/Upload-video-to-server.md index 391d376ca..6fb3fc46e 100644 --- a/docs/en/md/VK/Community-managment/Upload-video-to-server.md +++ b/docs/en/md/VK/Community-managment/Upload-video-to-server.md @@ -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
diff --git a/docs/en/md/VK/Interactive-actions/Shorten-link.md b/docs/en/md/VK/Interactive-actions/Shorten-link.md index d2f0ba15b..08388f9ce 100644 --- a/docs/en/md/VK/Interactive-actions/Shorten-link.md +++ b/docs/en/md/VK/Interactive-actions/Shorten-link.md @@ -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
diff --git a/docs/en/md/VK/Order-management/Get-order-list.md b/docs/en/md/VK/Order-management/Get-order-list.md index a409dafec..83df0ae1d 100644 --- a/docs/en/md/VK/Order-management/Get-order-list.md +++ b/docs/en/md/VK/Order-management/Get-order-list.md @@ -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
diff --git a/docs/en/md/VK/Product-properties-management/Add-product-property-variant.md b/docs/en/md/VK/Product-properties-management/Add-product-property-variant.md index 33b552aab..347e0596f 100644 --- a/docs/en/md/VK/Product-properties-management/Add-product-property-variant.md +++ b/docs/en/md/VK/Product-properties-management/Add-product-property-variant.md @@ -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
diff --git a/docs/en/md/VK/Product-properties-management/Create-product-property.md b/docs/en/md/VK/Product-properties-management/Create-product-property.md index 753533694..5c803e7cc 100644 --- a/docs/en/md/VK/Product-properties-management/Create-product-property.md +++ b/docs/en/md/VK/Product-properties-management/Create-product-property.md @@ -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
diff --git a/docs/en/md/VK/Product-properties-management/Delete-product-property-variant.md b/docs/en/md/VK/Product-properties-management/Delete-product-property-variant.md index 18bed5c08..95859aa55 100644 --- a/docs/en/md/VK/Product-properties-management/Delete-product-property-variant.md +++ b/docs/en/md/VK/Product-properties-management/Delete-product-property-variant.md @@ -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
diff --git a/docs/en/md/VK/Product-properties-management/Delete-product-property.md b/docs/en/md/VK/Product-properties-management/Delete-product-property.md index 14a6690f8..8818a64fa 100644 --- a/docs/en/md/VK/Product-properties-management/Delete-product-property.md +++ b/docs/en/md/VK/Product-properties-management/Delete-product-property.md @@ -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
diff --git a/docs/en/md/VK/Product-properties-management/Edit-product-property-variant.md b/docs/en/md/VK/Product-properties-management/Edit-product-property-variant.md index 6fea4786e..ba14c43cc 100644 --- a/docs/en/md/VK/Product-properties-management/Edit-product-property-variant.md +++ b/docs/en/md/VK/Product-properties-management/Edit-product-property-variant.md @@ -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
diff --git a/docs/en/md/VK/Product-properties-management/Edit-product-property.md b/docs/en/md/VK/Product-properties-management/Edit-product-property.md index b8a4790bd..2fee5038b 100644 --- a/docs/en/md/VK/Product-properties-management/Edit-product-property.md +++ b/docs/en/md/VK/Product-properties-management/Edit-product-property.md @@ -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
diff --git a/docs/en/md/VK/Product-properties-management/Get-property-list.md b/docs/en/md/VK/Product-properties-management/Get-property-list.md index 663b12e55..f473deed0 100644 --- a/docs/en/md/VK/Product-properties-management/Get-property-list.md +++ b/docs/en/md/VK/Product-properties-management/Get-property-list.md @@ -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
diff --git a/docs/en/md/VK/Token-retrieval/Create-token-retrieval-link.md b/docs/en/md/VK/Token-retrieval/Create-token-retrieval-link.md index f5272d1d0..4c27e58e4 100644 --- a/docs/en/md/VK/Token-retrieval/Create-token-retrieval-link.md +++ b/docs/en/md/VK/Token-retrieval/Create-token-retrieval-link.md @@ -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
diff --git a/docs/en/md/Yandex_Disk/File-and-folder-management/Upload-file.md b/docs/en/md/Yandex_Disk/File-and-folder-management/Upload-file.md index b9d622b88..5b2475e35 100644 --- a/docs/en/md/Yandex_Disk/File-and-folder-management/Upload-file.md +++ b/docs/en/md/Yandex_Disk/File-and-folder-management/Upload-file.md @@ -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
diff --git a/docs/en/md/Yandex_Disk/Manage-public-access/Publish-object.md b/docs/en/md/Yandex_Disk/Manage-public-access/Publish-object.md index 4aef93eae..26a46f3f6 100644 --- a/docs/en/md/Yandex_Disk/Manage-public-access/Publish-object.md +++ b/docs/en/md/Yandex_Disk/Manage-public-access/Publish-object.md @@ -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
diff --git a/docs/ru/cli/Bitrix24/ДобавитьПользовательскоеПолеЗадачи.txt b/docs/ru/cli/Bitrix24/ДобавитьПользовательскоеПолеЗадачи.txt new file mode 100644 index 000000000..881e14e7f --- /dev/null +++ b/docs/ru/cli/Bitrix24/ДобавитьПользовательскоеПолеЗадачи.txt @@ -0,0 +1 @@ +oint bitrix24 ДобавитьПользовательскоеПолеЗадачи --url %url% --type %type% --fieldname %fieldname% --externalid %externalid% --title %title% --label %label% --token %token% diff --git a/docs/ru/cli/Bitrix24/ЗавершитьУчетВремени.txt b/docs/ru/cli/Bitrix24/ЗавершитьУчетВремени.txt new file mode 100644 index 000000000..fb45cf68b --- /dev/null +++ b/docs/ru/cli/Bitrix24/ЗавершитьУчетВремени.txt @@ -0,0 +1 @@ +oint bitrix24 ЗавершитьУчетВремени --url %url% --userid %userid% --time %time% --report %report% --token %token% diff --git a/docs/ru/cli/Bitrix24/ИзменитьПодразделение.txt b/docs/ru/cli/Bitrix24/ИзменитьПодразделение.txt new file mode 100644 index 000000000..2d86b0d60 --- /dev/null +++ b/docs/ru/cli/Bitrix24/ИзменитьПодразделение.txt @@ -0,0 +1 @@ +oint bitrix24 ИзменитьПодразделение --url %url% --depid %depid% --title %title% --parentid %parentid% --headid %headid% --token %token% diff --git a/docs/ru/cli/Bitrix24/ИзменитьПользовательскоеПолеЗадачи.txt b/docs/ru/cli/Bitrix24/ИзменитьПользовательскоеПолеЗадачи.txt new file mode 100644 index 000000000..839821486 --- /dev/null +++ b/docs/ru/cli/Bitrix24/ИзменитьПользовательскоеПолеЗадачи.txt @@ -0,0 +1 @@ +oint bitrix24 ИзменитьПользовательскоеПолеЗадачи --url %url% --fieldid %fieldid% --externalid %externalid% --title %title% --label %label% --token %token% diff --git a/docs/ru/cli/Bitrix24/ИзменитьПользователя.txt b/docs/ru/cli/Bitrix24/ИзменитьПользователя.txt new file mode 100644 index 000000000..70aa0c2c8 --- /dev/null +++ b/docs/ru/cli/Bitrix24/ИзменитьПользователя.txt @@ -0,0 +1 @@ +oint bitrix24 ИзменитьПользователя --url %url% --userid %userid% --fields %fields% --token %token% diff --git a/docs/ru/cli/Bitrix24/ИзменитьСтатусПользователя.txt b/docs/ru/cli/Bitrix24/ИзменитьСтатусПользователя.txt new file mode 100644 index 000000000..fad650942 --- /dev/null +++ b/docs/ru/cli/Bitrix24/ИзменитьСтатусПользователя.txt @@ -0,0 +1 @@ +oint bitrix24 ИзменитьСтатусПользователя --url %url% --userid %userid% --fire %fire% --token %token% diff --git a/docs/ru/cli/Bitrix24/НайтиПользователей.txt b/docs/ru/cli/Bitrix24/НайтиПользователей.txt new file mode 100644 index 000000000..b73d31a70 --- /dev/null +++ b/docs/ru/cli/Bitrix24/НайтиПользователей.txt @@ -0,0 +1 @@ +oint bitrix24 НайтиПользователей --url %url% --filter %filter% --token %token% diff --git a/docs/ru/cli/Bitrix24/НачатьУчетВремени.txt b/docs/ru/cli/Bitrix24/НачатьУчетВремени.txt new file mode 100644 index 000000000..760237958 --- /dev/null +++ b/docs/ru/cli/Bitrix24/НачатьУчетВремени.txt @@ -0,0 +1 @@ +oint bitrix24 НачатьУчетВремени --url %url% --userid %userid% --time %time% --report %report% --token %token% diff --git a/docs/ru/cli/Bitrix24/ПолучитьНастройкиУчетаВремени.txt b/docs/ru/cli/Bitrix24/ПолучитьНастройкиУчетаВремени.txt new file mode 100644 index 000000000..184508089 --- /dev/null +++ b/docs/ru/cli/Bitrix24/ПолучитьНастройкиУчетаВремени.txt @@ -0,0 +1 @@ +oint bitrix24 ПолучитьНастройкиУчетаВремени --url %url% --userid %userid% --token %token% diff --git a/docs/ru/cli/Bitrix24/ПолучитьПодразделения.txt b/docs/ru/cli/Bitrix24/ПолучитьПодразделения.txt new file mode 100644 index 000000000..abbe29ba0 --- /dev/null +++ b/docs/ru/cli/Bitrix24/ПолучитьПодразделения.txt @@ -0,0 +1 @@ +oint bitrix24 ПолучитьПодразделения --url %url% --depid %depid% --title %title% --parentid %parentid% --headid %headid% --token %token% diff --git a/docs/ru/cli/Bitrix24/ПолучитьПользователей.txt b/docs/ru/cli/Bitrix24/ПолучитьПользователей.txt new file mode 100644 index 000000000..d108c9791 --- /dev/null +++ b/docs/ru/cli/Bitrix24/ПолучитьПользователей.txt @@ -0,0 +1 @@ +oint bitrix24 ПолучитьПользователей --url %url% --users %users% --token %token% diff --git a/docs/ru/cli/Bitrix24/ПолучитьПользовательскоеПолеЗадачи.txt b/docs/ru/cli/Bitrix24/ПолучитьПользовательскоеПолеЗадачи.txt new file mode 100644 index 000000000..c7322d6bc --- /dev/null +++ b/docs/ru/cli/Bitrix24/ПолучитьПользовательскоеПолеЗадачи.txt @@ -0,0 +1 @@ +oint bitrix24 ПолучитьПользовательскоеПолеЗадачи --url %url% --fieldid %fieldid% --token %token% diff --git a/docs/ru/cli/Bitrix24/ПолучитьПользователя.txt b/docs/ru/cli/Bitrix24/ПолучитьПользователя.txt new file mode 100644 index 000000000..f6463261a --- /dev/null +++ b/docs/ru/cli/Bitrix24/ПолучитьПользователя.txt @@ -0,0 +1 @@ +oint bitrix24 ПолучитьПользователя --url %url% --userid %userid% --token %token% diff --git a/docs/ru/cli/Bitrix24/ПолучитьСписокПользовательскихПолейЗадачи.txt b/docs/ru/cli/Bitrix24/ПолучитьСписокПользовательскихПолейЗадачи.txt new file mode 100644 index 000000000..5a1310499 --- /dev/null +++ b/docs/ru/cli/Bitrix24/ПолучитьСписокПользовательскихПолейЗадачи.txt @@ -0,0 +1 @@ +oint bitrix24 ПолучитьСписокПользовательскихПолейЗадачи --url %url% --token %token% diff --git a/docs/ru/cli/Bitrix24/ПолучитьСтатусПользователя.txt b/docs/ru/cli/Bitrix24/ПолучитьСтатусПользователя.txt new file mode 100644 index 000000000..a6592c02c --- /dev/null +++ b/docs/ru/cli/Bitrix24/ПолучитьСтатусПользователя.txt @@ -0,0 +1 @@ +oint bitrix24 ПолучитьСтатусПользователя --url %url% --token %token% diff --git a/docs/ru/cli/Bitrix24/ПолучитьСтатусУчетаВремени.txt b/docs/ru/cli/Bitrix24/ПолучитьСтатусУчетаВремени.txt new file mode 100644 index 000000000..9db8f31cc --- /dev/null +++ b/docs/ru/cli/Bitrix24/ПолучитьСтатусУчетаВремени.txt @@ -0,0 +1 @@ +oint bitrix24 ПолучитьСтатусУчетаВремени --url %url% --userid %userid% --token %token% diff --git a/docs/ru/cli/Bitrix24/ПолучитьСтруктуруФильтраПользователей.txt b/docs/ru/cli/Bitrix24/ПолучитьСтруктуруФильтраПользователей.txt new file mode 100644 index 000000000..8dc4d79fb --- /dev/null +++ b/docs/ru/cli/Bitrix24/ПолучитьСтруктуруФильтраПользователей.txt @@ -0,0 +1 @@ +oint bitrix24 ПолучитьСтруктуруФильтраПользователей --empty %empty% diff --git a/docs/ru/cli/Bitrix24/ПолучитьСтурктуруПользователя.txt b/docs/ru/cli/Bitrix24/ПолучитьСтурктуруПользователя.txt new file mode 100644 index 000000000..9fb97783d --- /dev/null +++ b/docs/ru/cli/Bitrix24/ПолучитьСтурктуруПользователя.txt @@ -0,0 +1 @@ +oint bitrix24 ПолучитьСтурктуруПользователя --url %url% --token %token% diff --git a/docs/ru/cli/Bitrix24/ПолучитьТекущегоПользователя.txt b/docs/ru/cli/Bitrix24/ПолучитьТекущегоПользователя.txt new file mode 100644 index 000000000..3edd1b1d7 --- /dev/null +++ b/docs/ru/cli/Bitrix24/ПолучитьТекущегоПользователя.txt @@ -0,0 +1 @@ +oint bitrix24 ПолучитьТекущегоПользователя --url %url% --token %token% diff --git a/docs/ru/cli/Bitrix24/ПриостановитьУчетВремени.txt b/docs/ru/cli/Bitrix24/ПриостановитьУчетВремени.txt new file mode 100644 index 000000000..0f892c86b --- /dev/null +++ b/docs/ru/cli/Bitrix24/ПриостановитьУчетВремени.txt @@ -0,0 +1 @@ +oint bitrix24 ПриостановитьУчетВремени --url %url% --userid %userid% --token %token% diff --git a/docs/ru/cli/Bitrix24/СоздатьПерсональноеУведомление.txt b/docs/ru/cli/Bitrix24/СоздатьПерсональноеУведомление.txt new file mode 100644 index 000000000..d9ef15809 --- /dev/null +++ b/docs/ru/cli/Bitrix24/СоздатьПерсональноеУведомление.txt @@ -0,0 +1 @@ +oint bitrix24 СоздатьПерсональноеУведомление --url %url% --user %user% --text %text% --tag %tag% --blocks %blocks% --token %token% diff --git a/docs/ru/cli/Bitrix24/СоздатьПодразделение.txt b/docs/ru/cli/Bitrix24/СоздатьПодразделение.txt new file mode 100644 index 000000000..4fc643d5b --- /dev/null +++ b/docs/ru/cli/Bitrix24/СоздатьПодразделение.txt @@ -0,0 +1 @@ +oint bitrix24 СоздатьПодразделение --url %url% --title %title% --parentid %parentid% --headid %headid% --token %token% diff --git a/docs/ru/cli/Bitrix24/СоздатьПользователя.txt b/docs/ru/cli/Bitrix24/СоздатьПользователя.txt new file mode 100644 index 000000000..a4cf63fd8 --- /dev/null +++ b/docs/ru/cli/Bitrix24/СоздатьПользователя.txt @@ -0,0 +1 @@ +oint bitrix24 СоздатьПользователя --url %url% --fields %fields% --token %token% diff --git a/docs/ru/cli/Bitrix24/СоздатьСистемноеУведомление.txt b/docs/ru/cli/Bitrix24/СоздатьСистемноеУведомление.txt new file mode 100644 index 000000000..bdc2c2e45 --- /dev/null +++ b/docs/ru/cli/Bitrix24/СоздатьСистемноеУведомление.txt @@ -0,0 +1 @@ +oint bitrix24 СоздатьСистемноеУведомление --url %url% --user %user% --text %text% --tag %tag% --blocks %blocks% --token %token% diff --git a/docs/ru/cli/Bitrix24/УдалитьПодразделение.txt b/docs/ru/cli/Bitrix24/УдалитьПодразделение.txt new file mode 100644 index 000000000..df985a731 --- /dev/null +++ b/docs/ru/cli/Bitrix24/УдалитьПодразделение.txt @@ -0,0 +1 @@ +oint bitrix24 УдалитьПодразделение --url %url% --depid %depid% --token %token% diff --git a/docs/ru/cli/Bitrix24/УдалитьПользовательскоеПолеЗадачи.txt b/docs/ru/cli/Bitrix24/УдалитьПользовательскоеПолеЗадачи.txt new file mode 100644 index 000000000..91036cc5c --- /dev/null +++ b/docs/ru/cli/Bitrix24/УдалитьПользовательскоеПолеЗадачи.txt @@ -0,0 +1 @@ +oint bitrix24 УдалитьПользовательскоеПолеЗадачи --url %url% --fieldid %fieldid% --token %token% diff --git a/docs/ru/cli/Bitrix24/УдалитьУведомление.txt b/docs/ru/cli/Bitrix24/УдалитьУведомление.txt new file mode 100644 index 000000000..974cef1c1 --- /dev/null +++ b/docs/ru/cli/Bitrix24/УдалитьУведомление.txt @@ -0,0 +1 @@ +oint bitrix24 УдалитьУведомление --url %url% --notif %notif% --token %token% diff --git a/docs/ru/cli/Bitrix24/УстановитьСтатусПользователя.txt b/docs/ru/cli/Bitrix24/УстановитьСтатусПользователя.txt new file mode 100644 index 000000000..efc7ae0e1 --- /dev/null +++ b/docs/ru/cli/Bitrix24/УстановитьСтатусПользователя.txt @@ -0,0 +1 @@ +oint bitrix24 УстановитьСтатусПользователя --url %url% --status %status% --token %token% diff --git a/docs/ru/examples/Bitrix24/ДобавитьПользовательскоеПолеЗадачи.txt b/docs/ru/examples/Bitrix24/ДобавитьПользовательскоеПолеЗадачи.txt new file mode 100644 index 000000000..b8acd62fb --- /dev/null +++ b/docs/ru/examples/Bitrix24/ДобавитьПользовательскоеПолеЗадачи.txt @@ -0,0 +1,17 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + + Тип = "date"; + Имя = "BIRTHDAY_FIELD"; + + Результат = OPI_Bitrix24.ДобавитьПользовательскоеПолеЗадачи(URL, Тип, Имя); + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + + Тип = "string"; + Имя = "TEXT_FIELD"; + ВнешнийКод = "BITRIX_TEXT_FIELD"; + Заголовок = "Поле для текста"; + Подпись = Новый Структура("en,ru", "Some field", "Некоторое поле"); + + Результат = OPI_Bitrix24.ДобавитьПользовательскоеПолеЗадачи(URL, Тип, Имя, ВнешнийКод, Заголовок, Подпись, Токен); diff --git a/docs/ru/examples/Bitrix24/ЗавершитьУчетВремени.txt b/docs/ru/examples/Bitrix24/ЗавершитьУчетВремени.txt new file mode 100644 index 000000000..1accfe8e7 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ЗавершитьУчетВремени.txt @@ -0,0 +1,11 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + + Результат = OPI_Bitrix24.ЗавершитьУчетВремени(URL); + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDПользователя = 1; + Время = OPI_Инструменты.ПолучитьТекущуюДату(); + Отчет = "Отгул"; + + Результат = OPI_Bitrix24.ЗавершитьУчетВремени(URL, IDПользователя, Время, Отчет, ); diff --git a/docs/ru/examples/Bitrix24/ИзменитьПодразделение.txt b/docs/ru/examples/Bitrix24/ИзменитьПодразделение.txt new file mode 100644 index 000000000..117038c99 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ИзменитьПодразделение.txt @@ -0,0 +1,23 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + + IDПодразделения = ПараметрыФункции["Bitrix24_HookDepID"]; + IDРодителя = 7; + + Результат = OPI_Bitrix24.ИзменитьПодразделение(URL, IDПодразделения, , IDРодителя); + + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + + IDПодразделения = ПараметрыФункции["Bitrix24_DepID"]; + Наименование = "Новое подразделение"; + IDРодителя = 1; + IDРуководителя = 10; + + Результат = OPI_Bitrix24.ИзменитьПодразделение(URL + , IDПодразделения + , Наименование + , IDРодителя + , IDРуководителя + , Токен); diff --git a/docs/ru/examples/Bitrix24/ИзменитьПользовательскоеПолеЗадачи.txt b/docs/ru/examples/Bitrix24/ИзменитьПользовательскоеПолеЗадачи.txt new file mode 100644 index 000000000..8143a3f9c --- /dev/null +++ b/docs/ru/examples/Bitrix24/ИзменитьПользовательскоеПолеЗадачи.txt @@ -0,0 +1,15 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + + IDПоля = ПараметрыФункции["Bitrix24_HookTaskFieldID"]; + Заголовок = "Новый заголовок"; + + Результат = OPI_Bitrix24.ИзменитьПользовательскоеПолеЗадачи(URL, IDПоля, , Заголовок); + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + + IDПоля = ПараметрыФункции["Bitrix24_TaskFieldID"]; + ВнешнийКод = "NEW_TEXT_FIELD"; + Подпись = Новый Структура("en,ru", "Updated field", "Измененное поле"); + + Результат = OPI_Bitrix24.ИзменитьПользовательскоеПолеЗадачи(URL, IDПоля, ВнешнийКод, , Подпись, Токен); diff --git a/docs/ru/examples/Bitrix24/ИзменитьПользователя.txt b/docs/ru/examples/Bitrix24/ИзменитьПользователя.txt new file mode 100644 index 000000000..537be51bb --- /dev/null +++ b/docs/ru/examples/Bitrix24/ИзменитьПользователя.txt @@ -0,0 +1,26 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + IDПользователя = ПараметрыФункции["Bitrix24_HookUserID"]; + Почта = Строка(Новый УникальныйИдентификатор) + "@exepmple.org"; + + // Полную структуру можно получить функцией ПолучитьСтурктуруПользователя + + СтруктураПользователя = Новый Структура; + СтруктураПользователя.Вставить("EMAIL" , Почта); + СтруктураПользователя.Вставить("UF_DEPARTMENT", 1); + + Результат = OPI_Bitrix24.ИзменитьПользователя(URL, IDПользователя, СтруктураПользователя); + + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDПользователя = ПараметрыФункции["Bitrix24_UserID"]; + Почта = Строка(Новый УникальныйИдентификатор) + "@exepmple.org"; + + СтруктураПользователя = Новый Структура; + СтруктураПользователя.Вставить("EMAIL" , Почта); + СтруктураПользователя.Вставить("NAME" , "Олег"); + СтруктураПользователя.Вставить("LAST_NAME" , "Лама"); + СтруктураПользователя.Вставить("UF_DEPARTMENT" , 7); + + Результат = OPI_Bitrix24.ИзменитьПользователя(URL, IDПользователя, СтруктураПользователя, Токен); diff --git a/docs/ru/examples/Bitrix24/ИзменитьСтатусПользователя.txt b/docs/ru/examples/Bitrix24/ИзменитьСтатусПользователя.txt new file mode 100644 index 000000000..7a582a987 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ИзменитьСтатусПользователя.txt @@ -0,0 +1,12 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + IDПользователя = ПараметрыФункции["Bitrix24_HookUserID"]; + + Результат = OPI_Bitrix24.ИзменитьСтатусПользователя(URL, IDПользователя, Истина); + + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDПользователя = ПараметрыФункции["Bitrix24_UserID"]; + + Результат = OPI_Bitrix24.ИзменитьСтатусПользователя(URL, IDПользователя, Истина, Токен); diff --git a/docs/ru/examples/Bitrix24/НайтиПользователей.txt b/docs/ru/examples/Bitrix24/НайтиПользователей.txt new file mode 100644 index 000000000..ae60d083a --- /dev/null +++ b/docs/ru/examples/Bitrix24/НайтиПользователей.txt @@ -0,0 +1,20 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + + СтруктураФильтра = Новый Структура; + СтруктураФильтра.Вставить("NAME" , "Виталий"); + СтруктураФильтра.Вставить("LAST_NAME" , "Альпака"); + СтруктураФильтра.Вставить("WORK_POSITION" , "DevOps инженер"); + СтруктураФильтра.Вставить("UF_DEPARTMENT_NAME", "Отдел маркетинга"); + СтруктураФильтра.Вставить("USER_TYPE" , "employee"); + + Результат = OPI_Bitrix24.НайтиПользователей(URL, СтруктураФильтра); + + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + + СтруктураФильтра = Новый Структура; + СтруктураФильтра.Вставить("UF_DEPARTMENT_NAME", "Битрикс"); + + Результат = OPI_Bitrix24.НайтиПользователей(URL, СтруктураФильтра, Токен); diff --git a/docs/ru/examples/Bitrix24/НачатьУчетВремени.txt b/docs/ru/examples/Bitrix24/НачатьУчетВремени.txt new file mode 100644 index 000000000..ed65f3f82 --- /dev/null +++ b/docs/ru/examples/Bitrix24/НачатьУчетВремени.txt @@ -0,0 +1,13 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + + Результат = OPI_Bitrix24.НачатьУчетВремени(URL); + + Час = 3600; + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDПользователя = 1; + Время = OPI_Инструменты.ПолучитьТекущуюДату() - Час; + Отчет = "Опоздание"; + + Результат = OPI_Bitrix24.НачатьУчетВремени(URL, IDПользователя, Время, Отчет, ); diff --git a/docs/ru/examples/Bitrix24/ПолучитьНастройкиУчетаВремени.txt b/docs/ru/examples/Bitrix24/ПолучитьНастройкиУчетаВремени.txt new file mode 100644 index 000000000..8878512b8 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ПолучитьНастройкиУчетаВремени.txt @@ -0,0 +1,11 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + + Результат = OPI_Bitrix24.ПолучитьНастройкиУчетаВремени(URL); + + Час = 3600; + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDПользователя = 1; + + Результат = OPI_Bitrix24.ПолучитьНастройкиУчетаВремени(URL, IDПользователя); diff --git a/docs/ru/examples/Bitrix24/ПолучитьПодразделения.txt b/docs/ru/examples/Bitrix24/ПолучитьПодразделения.txt new file mode 100644 index 000000000..c21b74a90 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ПолучитьПодразделения.txt @@ -0,0 +1,12 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + IDПодразделения = ПараметрыФункции["Bitrix24_DepID"]; + + Результат = OPI_Bitrix24.ПолучитьПодразделения(URL, IDПодразделения); + + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDРуководителя = 1; + + Результат = OPI_Bitrix24.ПолучитьПодразделения(URL, , , , IDРуководителя, Токен); diff --git a/docs/ru/examples/Bitrix24/ПолучитьПользователей.txt b/docs/ru/examples/Bitrix24/ПолучитьПользователей.txt new file mode 100644 index 000000000..2834918be --- /dev/null +++ b/docs/ru/examples/Bitrix24/ПолучитьПользователей.txt @@ -0,0 +1,15 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + МассивПользователей = Новый Массив; + + МассивПользователей.Добавить(1); + МассивПользователей.Добавить(10); + + Результат = OPI_Bitrix24.ПолучитьПользователей(URL, МассивПользователей); + + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDПользователей = 10; + + Результат = OPI_Bitrix24.ПолучитьПользователей(URL, IDПользователей, Токен); diff --git a/docs/ru/examples/Bitrix24/ПолучитьПользовательскоеПолеЗадачи.txt b/docs/ru/examples/Bitrix24/ПолучитьПользовательскоеПолеЗадачи.txt new file mode 100644 index 000000000..c8721b1b6 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ПолучитьПользовательскоеПолеЗадачи.txt @@ -0,0 +1,10 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + IDПоля = ПараметрыФункции["Bitrix24_HookTaskFieldID"]; + + Результат = OPI_Bitrix24.ПолучитьПользовательскоеПолеЗадачи(URL, IDПоля); + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDПоля = ПараметрыФункции["Bitrix24_TaskFieldID"]; + + Результат = OPI_Bitrix24.ПолучитьПользовательскоеПолеЗадачи(URL, IDПоля, ); diff --git a/docs/ru/examples/Bitrix24/ПолучитьПользователя.txt b/docs/ru/examples/Bitrix24/ПолучитьПользователя.txt new file mode 100644 index 000000000..d95783ef3 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ПолучитьПользователя.txt @@ -0,0 +1,12 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + IDПользователя = ПараметрыФункции["Bitrix24_HookUserID"]; + + Результат = OPI_Bitrix24.ПолучитьПользователя(URL, IDПользователя); + + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDПользователя = ПараметрыФункции["Bitrix24_UserID"]; + + Результат = OPI_Bitrix24.ПолучитьПользователя(URL, IDПользователя, Токен); diff --git a/docs/ru/examples/Bitrix24/ПолучитьСписокПользовательскихПолейЗадачи.txt b/docs/ru/examples/Bitrix24/ПолучитьСписокПользовательскихПолейЗадачи.txt new file mode 100644 index 000000000..e69c0abd1 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ПолучитьСписокПользовательскихПолейЗадачи.txt @@ -0,0 +1,8 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + + Результат = OPI_Bitrix24.ПолучитьСписокПользовательскихПолейЗадачи(URL); + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + + Результат = OPI_Bitrix24.ПолучитьСписокПользовательскихПолейЗадачи(URL); diff --git a/docs/ru/examples/Bitrix24/ПолучитьСтатусПользователя.txt b/docs/ru/examples/Bitrix24/ПолучитьСтатусПользователя.txt new file mode 100644 index 000000000..9f277c57f --- /dev/null +++ b/docs/ru/examples/Bitrix24/ПолучитьСтатусПользователя.txt @@ -0,0 +1,10 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + + Результат = OPI_Bitrix24.ПолучитьСтатусПользователя(URL); + + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + + Результат = OPI_Bitrix24.ПолучитьСтатусПользователя(URL, Токен); diff --git a/docs/ru/examples/Bitrix24/ПолучитьСтатусУчетаВремени.txt b/docs/ru/examples/Bitrix24/ПолучитьСтатусУчетаВремени.txt new file mode 100644 index 000000000..b26beb5ee --- /dev/null +++ b/docs/ru/examples/Bitrix24/ПолучитьСтатусУчетаВремени.txt @@ -0,0 +1,11 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + + Результат = OPI_Bitrix24.ПолучитьСтатусУчетаВремени(URL); + + Час = 3600; + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDПользователя = 1; + + Результат = OPI_Bitrix24.ПолучитьСтатусУчетаВремени(URL, IDПользователя); diff --git a/docs/ru/examples/Bitrix24/ПолучитьСтурктуруПользователя.txt b/docs/ru/examples/Bitrix24/ПолучитьСтурктуруПользователя.txt new file mode 100644 index 000000000..e1731dbd6 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ПолучитьСтурктуруПользователя.txt @@ -0,0 +1,10 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + + Результат = OPI_Bitrix24.ПолучитьСтурктуруПользователя(URL); + + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + + Результат = OPI_Bitrix24.ПолучитьСтурктуруПользователя(URL, Токен); diff --git a/docs/ru/examples/Bitrix24/ПолучитьТекущегоПользователя.txt b/docs/ru/examples/Bitrix24/ПолучитьТекущегоПользователя.txt new file mode 100644 index 000000000..36f06d675 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ПолучитьТекущегоПользователя.txt @@ -0,0 +1,10 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + + Результат = OPI_Bitrix24.ПолучитьТекущегоПользователя(URL); + + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + + Результат = OPI_Bitrix24.ПолучитьТекущегоПользователя(URL, Токен); diff --git a/docs/ru/examples/Bitrix24/ПриостановитьУчетВремени.txt b/docs/ru/examples/Bitrix24/ПриостановитьУчетВремени.txt new file mode 100644 index 000000000..a19ab3470 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ПриостановитьУчетВремени.txt @@ -0,0 +1,11 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + + Результат = OPI_Bitrix24.ПриостановитьУчетВремени(URL); + + Час = 3600; + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDПользователя = 1; + + Результат = OPI_Bitrix24.ПриостановитьУчетВремени(URL, IDПользователя); diff --git a/docs/ru/examples/Bitrix24/СоздатьПерсональноеУведомление.txt b/docs/ru/examples/Bitrix24/СоздатьПерсональноеУведомление.txt new file mode 100644 index 000000000..99fd23dfb --- /dev/null +++ b/docs/ru/examples/Bitrix24/СоздатьПерсональноеУведомление.txt @@ -0,0 +1,22 @@ + IDПользователя = 1; + + URL = ПараметрыФункции["Bitrix24_URL"]; + Текст = "Текст сообщения"; + Картинка = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg"; + Файл = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx"; + + Вложения = Новый Массив; + Вложения.Добавить(OPI_Bitrix24.ПолучитьБлокКартинки("Картинка1", Картинка)); + Вложения.Добавить(OPI_Bitrix24.ПолучитьБлокФайла("Файл1.docx" , Файл)); + + Результат = OPI_Bitrix24.СоздатьПерсональноеУведомление(URL, IDПользователя, Текст, ,Вложения); + + + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + Тег = "Новый"; + IDПользователя = 10; + + Результат = OPI_Bitrix24.СоздатьПерсональноеУведомление(URL, IDПользователя, Текст, Тег, , Токен); diff --git a/docs/ru/examples/Bitrix24/СоздатьПодразделение.txt b/docs/ru/examples/Bitrix24/СоздатьПодразделение.txt new file mode 100644 index 000000000..5b63a71fc --- /dev/null +++ b/docs/ru/examples/Bitrix24/СоздатьПодразделение.txt @@ -0,0 +1,18 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + + Наименование = "Главное подразделение"; + IDРодителя = 1; + + Результат = OPI_Bitrix24.СоздатьПодразделение(URL, Наименование, IDРодителя); + + + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + + Наименование = "Подчиненное подразделение"; + IDРодителя = ПараметрыФункции["Bitrix24_HookDepID"]; + IDРуководителя = 1; + + Результат = OPI_Bitrix24.СоздатьПодразделение(URL, Наименование, IDРодителя, IDРуководителя, Токен); diff --git a/docs/ru/examples/Bitrix24/СоздатьПользователя.txt b/docs/ru/examples/Bitrix24/СоздатьПользователя.txt new file mode 100644 index 000000000..6caf8b7ac --- /dev/null +++ b/docs/ru/examples/Bitrix24/СоздатьПользователя.txt @@ -0,0 +1,25 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + Почта = Строка(Новый УникальныйИдентификатор) + "@exepmple.org"; + // Полную структуру можно получить функцией ПолучитьСтурктуруПользователя + + СтруктураПользователя = Новый Структура; + СтруктураПользователя.Вставить("EMAIL" , Почта); + СтруктураПользователя.Вставить("UF_DEPARTMENT", 7); + + Результат = OPI_Bitrix24.СоздатьПользователя(URL, СтруктураПользователя); + + + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + Почта = Строка(Новый УникальныйИдентификатор) + "@exepmple.org"; + + СтруктураПользователя = Новый Структура; + СтруктураПользователя.Вставить("EMAIL" , Почта); + СтруктураПользователя.Вставить("NAME" , "Виталий"); + СтруктураПользователя.Вставить("LAST_NAME" , "Альпака"); + СтруктураПользователя.Вставить("PERSONAL_MOBILE", "88003553535"); + СтруктураПользователя.Вставить("UF_DEPARTMENT" , 1); + + Результат = OPI_Bitrix24.СоздатьПользователя(URL, СтруктураПользователя, Токен); diff --git a/docs/ru/examples/Bitrix24/СоздатьСистемноеУведомление.txt b/docs/ru/examples/Bitrix24/СоздатьСистемноеУведомление.txt new file mode 100644 index 000000000..ba7b90ada --- /dev/null +++ b/docs/ru/examples/Bitrix24/СоздатьСистемноеУведомление.txt @@ -0,0 +1,22 @@ + IDПользователя = 1; + + URL = ПараметрыФункции["Bitrix24_URL"]; + Текст = "Текст сообщения"; + Картинка = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg"; + Файл = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx"; + + Вложения = Новый Массив; + Вложения.Добавить(OPI_Bitrix24.ПолучитьБлокКартинки("Картинка1", Картинка)); + Вложения.Добавить(OPI_Bitrix24.ПолучитьБлокФайла("Файл1.docx" , Файл)); + + Результат = OPI_Bitrix24.СоздатьСистемноеУведомление(URL, IDПользователя, Текст, ,Вложения); + + + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + Тег = "Новый"; + IDПользователя = 10; + + Результат = OPI_Bitrix24.СоздатьСистемноеУведомление(URL, IDПользователя, Текст, Тег, , Токен); diff --git a/docs/ru/examples/Bitrix24/УдалитьПодразделение.txt b/docs/ru/examples/Bitrix24/УдалитьПодразделение.txt new file mode 100644 index 000000000..dcd83e95d --- /dev/null +++ b/docs/ru/examples/Bitrix24/УдалитьПодразделение.txt @@ -0,0 +1,12 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + IDПодразделения = ПараметрыФункции["Bitrix24_DepID"]; + + Результат = OPI_Bitrix24.УдалитьПодразделение(URL, IDПодразделения); + + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDПодразделения = ПараметрыФункции["Bitrix24_HookDepID"]; + + Результат = OPI_Bitrix24.УдалитьПодразделение(URL, IDПодразделения, Токен); diff --git a/docs/ru/examples/Bitrix24/УдалитьПользовательскоеПолеЗадачи.txt b/docs/ru/examples/Bitrix24/УдалитьПользовательскоеПолеЗадачи.txt new file mode 100644 index 000000000..22a1818b8 --- /dev/null +++ b/docs/ru/examples/Bitrix24/УдалитьПользовательскоеПолеЗадачи.txt @@ -0,0 +1,10 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + IDПоля = ПараметрыФункции["Bitrix24_HookTaskFieldID"]; + + Результат = OPI_Bitrix24.УдалитьПользовательскоеПолеЗадачи(URL, IDПоля); + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDПоля = ПараметрыФункции["Bitrix24_TaskFieldID"]; + + Результат = OPI_Bitrix24.УдалитьПользовательскоеПолеЗадачи(URL, IDПоля, ); diff --git a/docs/ru/examples/Bitrix24/УдалитьУведомление.txt b/docs/ru/examples/Bitrix24/УдалитьУведомление.txt new file mode 100644 index 000000000..63c982cb1 --- /dev/null +++ b/docs/ru/examples/Bitrix24/УдалитьУведомление.txt @@ -0,0 +1,12 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + IDУведомления = ПараметрыФункции["Bitrix24_PersoalHookNotifyID"]; + + Результат = OPI_Bitrix24.УдалитьУведомление(URL, IDУведомления); + + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDУведомления = ПараметрыФункции["Bitrix24_PersoalNotifyID"]; + + Результат = OPI_Bitrix24.УдалитьУведомление(URL, IDУведомления, Токен); diff --git a/docs/ru/examples/Bitrix24/УстановитьСтатусПользователя.txt b/docs/ru/examples/Bitrix24/УстановитьСтатусПользователя.txt new file mode 100644 index 000000000..ac0d60f88 --- /dev/null +++ b/docs/ru/examples/Bitrix24/УстановитьСтатусПользователя.txt @@ -0,0 +1,12 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + Статус = "dnd"; + + Результат = OPI_Bitrix24.УстановитьСтатусПользователя(URL, Статус); + + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + Статус = "away"; + + Результат = OPI_Bitrix24.УстановитьСтатусПользователя(URL, Статус, Токен); diff --git a/docs/ru/md/Airtable/Comment-management/Delete-comment.md b/docs/ru/md/Airtable/Comment-management/Delete-comment.md index ed3e1542c..3cce4a8e0 100644 --- a/docs/ru/md/Airtable/Comment-management/Delete-comment.md +++ b/docs/ru/md/Airtable/Comment-management/Delete-comment.md @@ -18,7 +18,7 @@ sidebar_position: 4 | Комментарий | --comment | Строка | Идентификатор комментария | - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable
diff --git a/docs/ru/md/Airtable/Working-with-databases/Get-list-of-bases.md b/docs/ru/md/Airtable/Working-with-databases/Get-list-of-bases.md index fa59135f5..84fdca946 100644 --- a/docs/ru/md/Airtable/Working-with-databases/Get-list-of-bases.md +++ b/docs/ru/md/Airtable/Working-with-databases/Get-list-of-bases.md @@ -15,7 +15,7 @@ sidebar_position: 1 | Отступ | --offset | Строка | Идентификатор следующей страницы списка баз из перыдудщего запроса | - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable
diff --git a/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-filter-structure.md b/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-filter-structure.md index 22a02b17a..c676877ac 100644 --- a/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-filter-structure.md +++ b/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-filter-structure.md @@ -16,7 +16,7 @@ sidebar_position: 11 | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - Возвращаемое значение: Структура Из КлючИЗначение - Структура полей + Возвращаемое значение: Структура Из КлючИЗначение - Структура полей
diff --git a/docs/ru/md/Bitrix24/Catalogs-managment/_category_.json b/docs/ru/md/Bitrix24/Catalogs-managment/_category_.json index 108d856a3..d4f1d71bf 100644 --- a/docs/ru/md/Bitrix24/Catalogs-managment/_category_.json +++ b/docs/ru/md/Bitrix24/Catalogs-managment/_category_.json @@ -1,4 +1,4 @@ { "label": "Работа с каталогами", -"position": "10" +"position": "11" } \ No newline at end of file diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Add-users-to-chat.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Add-users-to-chat.md index 13c82e406..ad61b0566 100644 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Add-users-to-chat.md +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Add-users-to-chat.md @@ -1,5 +1,5 @@ --- -sidebar_position: 4 +sidebar_position: 5 --- # Добавить пользователей в чат diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-color.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-color.md index d98f780a6..333389413 100644 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-color.md +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-color.md @@ -1,5 +1,5 @@ --- -sidebar_position: 7 +sidebar_position: 8 --- # Изменить цвет чата diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-owner.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-owner.md index 59962af36..8e9d878dc 100644 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-owner.md +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-owner.md @@ -1,5 +1,5 @@ --- -sidebar_position: 9 +sidebar_position: 10 --- # Сменить владельца чата diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-picture.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-picture.md index a47b8685e..fc125fd9f 100644 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-picture.md +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-picture.md @@ -1,5 +1,5 @@ --- -sidebar_position: 8 +sidebar_position: 9 --- # Изменить картинку чата diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-title.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-title.md index 2a615575c..91195c435 100644 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-title.md +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-title.md @@ -1,5 +1,5 @@ --- -sidebar_position: 6 +sidebar_position: 7 --- # Изменить заголовок чата diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Delete-user-from-chat.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Delete-user-from-chat.md index a6f3ef626..f2db48665 100644 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Delete-user-from-chat.md +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Delete-user-from-chat.md @@ -1,5 +1,5 @@ --- -sidebar_position: 5 +sidebar_position: 6 --- # Исключить пользователя из чата diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Disable-chat-notifications.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Disable-chat-notifications.md index d890863b5..998c4e8b7 100644 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Disable-chat-notifications.md +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Disable-chat-notifications.md @@ -1,5 +1,5 @@ --- -sidebar_position: 10 +sidebar_position: 11 --- # Отключить уведомления чата diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Enable-chat-notifications.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Enable-chat-notifications.md index e504b59c5..fbfdc7783 100644 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Enable-chat-notifications.md +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Enable-chat-notifications.md @@ -1,5 +1,5 @@ --- -sidebar_position: 11 +sidebar_position: 12 --- # Включить уведомления чата diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-files-folder.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-files-folder.md index d888702ce..7126d3c63 100644 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-files-folder.md +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-files-folder.md @@ -1,5 +1,5 @@ --- -sidebar_position: 17 +sidebar_position: 20 --- # Получить каталог файлов чата diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-members-list.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-members-list.md index a446598e8..f3f743dfa 100644 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-members-list.md +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-members-list.md @@ -1,5 +1,5 @@ --- -sidebar_position: 14 +sidebar_position: 15 --- # Получить список пользователей диалога diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-messages-list.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-messages-list.md index e5460e21a..91ce80947 100644 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-messages-list.md +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-messages-list.md @@ -1,5 +1,5 @@ --- -sidebar_position: 12 +sidebar_position: 13 --- # Получить список сообщений чата diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-structure.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-structure.md index 9114e8217..72e67ea15 100644 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-structure.md +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-structure.md @@ -1,5 +1,5 @@ --- -sidebar_position: 18 +sidebar_position: 21 --- # Получить структуру чата @@ -14,7 +14,7 @@ sidebar_position: 18 | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания типов полей | - Возвращаемое значение: Структура Из КлючИЗначение - Структура полей + Возвращаемое значение: Структура Из КлючИЗначение - Структура полей
diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-dialog.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-dialog.md index e0fac0232..0d39673a9 100644 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-dialog.md +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-dialog.md @@ -1,5 +1,5 @@ --- -sidebar_position: 13 +sidebar_position: 14 --- # Получить диалог diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-user-status.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-user-status.md new file mode 100644 index 000000000..1e361c9b3 --- /dev/null +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-user-status.md @@ -0,0 +1,54 @@ +--- +sidebar_position: 17 +--- + +# Получить статус пользователя + Получает статус (онлайн) текущего пользователя + + + +`Функция ПолучитьСтатусПользователя(Знач URL, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.user.status.get](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11497) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + + Результат = OPI_Bitrix24.ПолучитьСтатусПользователя(URL); + + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + + Результат = OPI_Bitrix24.ПолучитьСтатусПользователя(URL, Токен); +``` + + + +```sh title="Пример команды CLI" + +oint bitrix24 ПолучитьСтатусПользователя --url %url% --token %token% + +``` + +```json title="Результат" +{ + "error": "expired_token", + "error_description": "The access token provided has expired." +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-users.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-users.md new file mode 100644 index 000000000..833be102c --- /dev/null +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-users.md @@ -0,0 +1,96 @@ +--- +sidebar_position: 4 +--- + +# Получить пользователей + Получает информацию о пользователях для диалога + + + +`Функция ПолучитьПользователей(Знач URL, Знач IDПользователей, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПользователей | --users | Массив Из Строка, Число | ID пользователя или нескольких пользователей | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.user.list.get ](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11493) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + МассивПользователей = Новый Массив; + + МассивПользователей.Добавить(1); + МассивПользователей.Добавить(10); + + Результат = OPI_Bitrix24.ПолучитьПользователей(URL, МассивПользователей); + + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDПользователей = 10; + + Результат = OPI_Bitrix24.ПолучитьПользователей(URL, IDПользователей, Токен); +``` + + + +```sh title="Пример команды CLI" + +oint bitrix24 ПолучитьПользователей --url %url% --users %users% --token %token% + +``` + +```json title="Результат" +{ + "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 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Read-all.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Read-all.md index f537becb6..a92485951 100644 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Read-all.md +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Read-all.md @@ -1,5 +1,5 @@ --- -sidebar_position: 16 +sidebar_position: 19 --- # Прочитать все diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Send-writing-notification.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Send-writing-notification.md index 0527d87c1..380f683af 100644 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Send-writing-notification.md +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Send-writing-notification.md @@ -1,5 +1,5 @@ --- -sidebar_position: 15 +sidebar_position: 16 --- # Отправить уведомление о вводе diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Set-user-status.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Set-user-status.md new file mode 100644 index 000000000..863c33e7b --- /dev/null +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Set-user-status.md @@ -0,0 +1,66 @@ +--- +sidebar_position: 18 +--- + +# Установить статус пользователя + Устанавливает статус (онлайн) текущего пользователя + + + +`Функция УстановитьСтатусПользователя(Знач URL, Знач Статус, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Статус | --status | Строка, Число | Статус пользователя: online, dnd, away | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.user.status.set](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11499) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + Статус = "dnd"; + + Результат = OPI_Bitrix24.УстановитьСтатусПользователя(URL, Статус); + + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + Статус = "away"; + + Результат = OPI_Bitrix24.УстановитьСтатусПользователя(URL, Статус, Токен); +``` + + + +```sh title="Пример команды CLI" + +oint bitrix24 УстановитьСтатусПользователя --url %url% --status %status% --token %token% + +``` + +```json title="Результат" +{ + "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 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/_category_.json b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/_category_.json index 3e039d836..6d28539ea 100644 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/_category_.json +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/_category_.json @@ -1,4 +1,4 @@ { "label": "Работа с чатами и диалогами", -"position": "12" +"position": "13" } \ No newline at end of file diff --git a/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-comment-structure.md b/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-comment-structure.md index 8d106f081..ed504d0b4 100644 --- a/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-comment-structure.md +++ b/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-comment-structure.md @@ -14,7 +14,7 @@ sidebar_position: 9 | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания полей | - Возвращаемое значение: Структура Из КлючИЗначение - Структура полей + Возвращаемое значение: Структура Из КлючИЗначение - Структура полей
diff --git a/docs/ru/md/Bitrix24/Comments-and-results-managment/_category_.json b/docs/ru/md/Bitrix24/Comments-and-results-managment/_category_.json index 54bda699a..4abbe9ded 100644 --- a/docs/ru/md/Bitrix24/Comments-and-results-managment/_category_.json +++ b/docs/ru/md/Bitrix24/Comments-and-results-managment/_category_.json @@ -1,4 +1,4 @@ { "label": "Работа с комментариями и результатами задач", -"position": "6" +"position": "7" } \ No newline at end of file diff --git a/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Add-custom-task-field.md b/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Add-custom-task-field.md new file mode 100644 index 000000000..c3c0326b0 --- /dev/null +++ b/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Add-custom-task-field.md @@ -0,0 +1,75 @@ +--- +sidebar_position: 2 +--- + +# Добавить пользовательское поле задачи + Добавляет новое пользовательское поле для добавления в задачу + + + +`Функция ДобавитьПользовательскоеПолеЗадачи(Знач URL, Знач Тип, Знач Имя, Знач ВнешнийКод = "", Знач Заголовок = "", Знач Подпись = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Тип | --type | Строка | Тип поля: string, double, date, boolean | + | Имя | --fieldname | Строка | Текстовый идентификатор (наименование) поля | + | ВнешнийКод | --externalid | Строка | Внешний текстовый идентификатор поля | + | Заголовок | --title | Строка | Заголовок поля | + | Подпись | --label | Структура Из КлючИЗначение | Подпись в форме. Ключ: en или ru, Значение: Текст подписи | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.item.userfield.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/add.php) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + + Тип = "date"; + Имя = "BIRTHDAY_FIELD"; + + Результат = OPI_Bitrix24.ДобавитьПользовательскоеПолеЗадачи(URL, Тип, Имя); + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + + Тип = "string"; + Имя = "TEXT_FIELD"; + ВнешнийКод = "BITRIX_TEXT_FIELD"; + Заголовок = "Поле для текста"; + Подпись = Новый Структура("en,ru", "Some field", "Некоторое поле"); + + Результат = OPI_Bitrix24.ДобавитьПользовательскоеПолеЗадачи(URL, Тип, Имя, ВнешнийКод, Заголовок, Подпись, Токен); +``` + + + +```sh title="Пример команды CLI" + +oint bitrix24 ДобавитьПользовательскоеПолеЗадачи --url %url% --type %type% --fieldname %fieldname% --externalid %externalid% --title %title% --label %label% --token %token% + +``` + +```json title="Результат" +{ + "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 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Delete-custom-task-field.md b/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Delete-custom-task-field.md new file mode 100644 index 000000000..8d561068d --- /dev/null +++ b/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Delete-custom-task-field.md @@ -0,0 +1,64 @@ +--- +sidebar_position: 5 +--- + +# Удалить пользовательское поле задачи + Удаляет пользовательское поле задачи + + + +`Функция УдалитьПользовательскоеПолеЗадачи(Знач URL, Знач IDПоля, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПоля | --fieldid | Строка, Число | ID поля для удаления | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.item.userfield.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/delete.php) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + IDПоля = ПараметрыФункции["Bitrix24_HookTaskFieldID"]; + + Результат = OPI_Bitrix24.УдалитьПользовательскоеПолеЗадачи(URL, IDПоля); + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDПоля = ПараметрыФункции["Bitrix24_TaskFieldID"]; + + Результат = OPI_Bitrix24.УдалитьПользовательскоеПолеЗадачи(URL, IDПоля, ); +``` + + + +```sh title="Пример команды CLI" + +oint bitrix24 УдалитьПользовательскоеПолеЗадачи --url %url% --fieldid %fieldid% --token %token% + +``` + +```json title="Результат" +{ + "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 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-field.md b/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-field.md new file mode 100644 index 000000000..f0cda62b4 --- /dev/null +++ b/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-field.md @@ -0,0 +1,186 @@ +--- +sidebar_position: 4 +--- + +# Получить пользовательское поле задачи + Получает информацию о пользовательском поле задачи + + + +`Функция ПолучитьПользовательскоеПолеЗадачи(Знач URL, Знач IDПоля, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПоля | --fieldid | Строка, Число | ID поля для получения | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.item.userfield.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/get.php) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + IDПоля = ПараметрыФункции["Bitrix24_HookTaskFieldID"]; + + Результат = OPI_Bitrix24.ПолучитьПользовательскоеПолеЗадачи(URL, IDПоля); + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDПоля = ПараметрыФункции["Bitrix24_TaskFieldID"]; + + Результат = OPI_Bitrix24.ПолучитьПользовательскоеПолеЗадачи(URL, IDПоля, ); +``` + + + +```sh title="Пример команды CLI" + +oint bitrix24 ПолучитьПользовательскоеПолеЗадачи --url %url% --fieldid %fieldid% --token %token% + +``` + +```json title="Результат" +{ + "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": "Измененное поле", + "sc": "", + "tc": "", + "th": "", + "tr": "", + "ua": "", + "vn": "" + }, + "LIST_COLUMN_LABEL": { + "ar": "Поле для текста", + "br": "Поле для текста", + "de": "Поле для текста", + "en": "Поле для текста", + "fr": "Поле для текста", + "id": "Поле для текста", + "it": "Поле для текста", + "ja": "Поле для текста", + "la": "Поле для текста", + "ms": "Поле для текста", + "pl": "Поле для текста", + "ru": "Поле для текста", + "sc": "Поле для текста", + "tc": "Поле для текста", + "th": "Поле для текста", + "tr": "Поле для текста", + "ua": "Поле для текста", + "vn": "Поле для текста" + }, + "LIST_FILTER_LABEL": { + "ar": "Поле для текста", + "br": "Поле для текста", + "de": "Поле для текста", + "en": "Поле для текста", + "fr": "Поле для текста", + "id": "Поле для текста", + "it": "Поле для текста", + "ja": "Поле для текста", + "la": "Поле для текста", + "ms": "Поле для текста", + "pl": "Поле для текста", + "ru": "Поле для текста", + "sc": "Поле для текста", + "tc": "Поле для текста", + "th": "Поле для текста", + "tr": "Поле для текста", + "ua": "Поле для текста", + "vn": "Поле для текста" + }, + "ERROR_MESSAGE": { + "ar": "Поле для текста", + "br": "Поле для текста", + "de": "Поле для текста", + "en": "Поле для текста", + "fr": "Поле для текста", + "id": "Поле для текста", + "it": "Поле для текста", + "ja": "Поле для текста", + "la": "Поле для текста", + "ms": "Поле для текста", + "pl": "Поле для текста", + "ru": "Поле для текста", + "sc": "Поле для текста", + "tc": "Поле для текста", + "th": "Поле для текста", + "tr": "Поле для текста", + "ua": "Поле для текста", + "vn": "Поле для текста" + }, + "HELP_MESSAGE": { + "ar": "Поле для текста", + "br": "Поле для текста", + "de": "Поле для текста", + "en": "Поле для текста", + "fr": "Поле для текста", + "id": "Поле для текста", + "it": "Поле для текста", + "ja": "Поле для текста", + "la": "Поле для текста", + "ms": "Поле для текста", + "pl": "Поле для текста", + "ru": "Поле для текста", + "sc": "Поле для текста", + "tc": "Поле для текста", + "th": "Поле для текста", + "tr": "Поле для текста", + "ua": "Поле для текста", + "vn": "Поле для текста" + } + }, + "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 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-fields-list.md b/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-fields-list.md new file mode 100644 index 000000000..4849ec601 --- /dev/null +++ b/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-fields-list.md @@ -0,0 +1,157 @@ +--- +sidebar_position: 1 +--- + +# Получить список пользовательских полей задачи + Получает список пользовательских полей для задач + + + +`Функция ПолучитьСписокПользовательскихПолейЗадачи(Знач URL, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.item.userfield.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/getlist.php) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + + Результат = OPI_Bitrix24.ПолучитьСписокПользовательскихПолейЗадачи(URL); + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + + Результат = OPI_Bitrix24.ПолучитьСписокПользовательскихПолейЗадачи(URL); +``` + + + +```sh title="Пример команды CLI" + +oint bitrix24 ПолучитьСписокПользовательскихПолейЗадачи --url %url% --token %token% + +``` + +```json title="Результат" +{ + "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 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Update-custom-task-field.md b/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Update-custom-task-field.md new file mode 100644 index 000000000..15203f323 --- /dev/null +++ b/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Update-custom-task-field.md @@ -0,0 +1,72 @@ +--- +sidebar_position: 3 +--- + +# Изменить пользовательское поле задачи + Изменяет пользовательское поле задачи + + + +`Функция ИзменитьПользовательскоеПолеЗадачи(Знач URL, Знач IDПоля, Знач ВнешнийКод = "", Знач Заголовок = "", Знач Подпись = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПоля | --fieldid | Строка, Число | ID поля для изменения | + | ВнешнийКод | --externalid | Строка | Внешний текстовый идентификатор поля | + | Заголовок | --title | Строка | Заголовок поля | + | Подпись | --label | Структура Из КлючИЗначение | Подпись в форме. Ключ: en или ru, Значение: Текст подписи | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.item.userfield.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/update.php) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + + IDПоля = ПараметрыФункции["Bitrix24_HookTaskFieldID"]; + Заголовок = "Новый заголовок"; + + Результат = OPI_Bitrix24.ИзменитьПользовательскоеПолеЗадачи(URL, IDПоля, , Заголовок); + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + + IDПоля = ПараметрыФункции["Bitrix24_TaskFieldID"]; + ВнешнийКод = "NEW_TEXT_FIELD"; + Подпись = Новый Структура("en,ru", "Updated field", "Измененное поле"); + + Результат = OPI_Bitrix24.ИзменитьПользовательскоеПолеЗадачи(URL, IDПоля, ВнешнийКод, , Подпись, Токен); +``` + + + +```sh title="Пример команды CLI" + +oint bitrix24 ИзменитьПользовательскоеПолеЗадачи --url %url% --fieldid %fieldid% --externalid %externalid% --title %title% --label %label% --token %token% + +``` + +```json title="Результат" +{ + "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 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/_category_.json b/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/_category_.json new file mode 100644 index 000000000..de7a21731 --- /dev/null +++ b/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Работа с пользовательскими полями задач", +"position": "5" +} \ No newline at end of file diff --git a/docs/ru/md/Bitrix24/Departments-managment/Create-department.md b/docs/ru/md/Bitrix24/Departments-managment/Create-department.md new file mode 100644 index 000000000..448e4914d --- /dev/null +++ b/docs/ru/md/Bitrix24/Departments-managment/Create-department.md @@ -0,0 +1,74 @@ +--- +sidebar_position: 1 +--- + +# Создать подразделение + Создает новое подразделение + + + +`Функция СоздатьПодразделение(Знач URL, Знач Наименование, Знач IDРодителя = "", Знач IDРуководителя = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Наименование | --title | Строка | Наименование подразделения | + | IDРодителя | --parentid | Строка, Число | ID родительского подразделения | + | IDРуководителя | --headid | Строка, Число | ID руководителя подразделения | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [department.add](https://dev.1c-bitrix.ru/rest_help/departments/department_add.php) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + + Наименование = "Главное подразделение"; + IDРодителя = 1; + + Результат = OPI_Bitrix24.СоздатьПодразделение(URL, Наименование, IDРодителя); + + + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + + Наименование = "Подчиненное подразделение"; + IDРодителя = ПараметрыФункции["Bitrix24_HookDepID"]; + IDРуководителя = 1; + + Результат = OPI_Bitrix24.СоздатьПодразделение(URL, Наименование, IDРодителя, IDРуководителя, Токен); +``` + + + +```sh title="Пример команды CLI" + +oint bitrix24 СоздатьПодразделение --url %url% --title %title% --parentid %parentid% --headid %headid% --token %token% + +``` + +```json title="Результат" +{ + "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 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Departments-managment/Delete-department.md b/docs/ru/md/Bitrix24/Departments-managment/Delete-department.md new file mode 100644 index 000000000..237820a41 --- /dev/null +++ b/docs/ru/md/Bitrix24/Departments-managment/Delete-department.md @@ -0,0 +1,66 @@ +--- +sidebar_position: 4 +--- + +# Удалить подразделение + Удаляет подразделение по ID + + + +`Функция УдалитьПодразделение(Знач URL, Знач IDПодразделения, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПодразделения | --depid | Строка, Число | ID подразделения для удаления | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [department.delete](https://dev.1c-bitrix.ru/rest_help/departments/department_delete.php) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + IDПодразделения = ПараметрыФункции["Bitrix24_DepID"]; + + Результат = OPI_Bitrix24.УдалитьПодразделение(URL, IDПодразделения); + + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDПодразделения = ПараметрыФункции["Bitrix24_HookDepID"]; + + Результат = OPI_Bitrix24.УдалитьПодразделение(URL, IDПодразделения, Токен); +``` + + + +```sh title="Пример команды CLI" + +oint bitrix24 УдалитьПодразделение --url %url% --depid %depid% --token %token% + +``` + +```json title="Результат" +{ + "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 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Departments-managment/Get-departments.md b/docs/ru/md/Bitrix24/Departments-managment/Get-departments.md new file mode 100644 index 000000000..f08c6ebec --- /dev/null +++ b/docs/ru/md/Bitrix24/Departments-managment/Get-departments.md @@ -0,0 +1,78 @@ +--- +sidebar_position: 3 +--- + +# Получить подразделения + Получает список подразделений по ID или фильтру + + + +`Функция ПолучитьПодразделения(Знач URL, Знач IDПодразделения = "", Знач Наименование = "", Знач IDРодителя = "", Знач IDРуководителя = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПодразделения | --depid | Строка, Число | Выбор по ID подразделения | + | Наименование | --title | Строка | Фильтр по наименованию | + | IDРодителя | --parentid | Строка, Число | Фильтр по родителю | + | IDРуководителя | --headid | Строка, Число | Фильтр по руководителю | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [department.get](https://dev.1c-bitrix.ru/rest_help/departments/department_get.php) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + IDПодразделения = ПараметрыФункции["Bitrix24_DepID"]; + + Результат = OPI_Bitrix24.ПолучитьПодразделения(URL, IDПодразделения); + + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDРуководителя = 1; + + Результат = OPI_Bitrix24.ПолучитьПодразделения(URL, , , , IDРуководителя, Токен); +``` + + + +```sh title="Пример команды CLI" + +oint bitrix24 ПолучитьПодразделения --url %url% --depid %depid% --title %title% --parentid %parentid% --headid %headid% --token %token% + +``` + +```json title="Результат" +{ + "result": [ + { + "ID": "42", + "NAME": "Подчиненное подразделение", + "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 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Departments-managment/Update-department.md b/docs/ru/md/Bitrix24/Departments-managment/Update-department.md new file mode 100644 index 000000000..0bd22753a --- /dev/null +++ b/docs/ru/md/Bitrix24/Departments-managment/Update-department.md @@ -0,0 +1,80 @@ +--- +sidebar_position: 2 +--- + +# Изменить подразделение + Изменяет существующее подразделение + + + +`Функция ИзменитьПодразделение(Знач URL, Знач IDПодразделения, Знач Наименование = "", Знач IDРодителя = "", Знач IDРуководителя = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПодразделения | --depid | Строка, Число | ID подразделения | + | Наименование | --title | Строка | Наименование подразделения | + | IDРодителя | --parentid | Строка, Число | ID родительского подразделения | + | IDРуководителя | --headid | Строка, Число | ID руководителя подразделения | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [department.update](https://dev.1c-bitrix.ru/rest_help/departments/department_update.php) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + + IDПодразделения = ПараметрыФункции["Bitrix24_HookDepID"]; + IDРодителя = 7; + + Результат = OPI_Bitrix24.ИзменитьПодразделение(URL, IDПодразделения, , IDРодителя); + + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + + IDПодразделения = ПараметрыФункции["Bitrix24_DepID"]; + Наименование = "Новое подразделение"; + IDРодителя = 1; + IDРуководителя = 10; + + Результат = OPI_Bitrix24.ИзменитьПодразделение(URL + , IDПодразделения + , Наименование + , IDРодителя + , IDРуководителя + , Токен); +``` + + + +```sh title="Пример команды CLI" + +oint bitrix24 ИзменитьПодразделение --url %url% --depid %depid% --title %title% --parentid %parentid% --headid %headid% --token %token% + +``` + +```json title="Результат" +{ + "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 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Departments-managment/_category_.json b/docs/ru/md/Bitrix24/Departments-managment/_category_.json new file mode 100644 index 000000000..a69252054 --- /dev/null +++ b/docs/ru/md/Bitrix24/Departments-managment/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Управление подразделениями", +"position": "16" +} \ No newline at end of file diff --git a/docs/ru/md/Bitrix24/Feed-posts-managment/Update-post.md b/docs/ru/md/Bitrix24/Feed-posts-managment/Update-post.md index 733b489a7..bdaa8a36d 100644 --- a/docs/ru/md/Bitrix24/Feed-posts-managment/Update-post.md +++ b/docs/ru/md/Bitrix24/Feed-posts-managment/Update-post.md @@ -25,7 +25,7 @@ sidebar_position: 2
:::tip -Метод в документации API: [log.blogpost.update](https://dev.1c-bitrix.ru/rest_help/log/log_blogpost_update.php.php) +Метод в документации API: [log.blogpost.update](https://dev.1c-bitrix.ru/rest_help/log/log_blogpost_update.php) :::
diff --git a/docs/ru/md/Bitrix24/File-managment/_category_.json b/docs/ru/md/Bitrix24/File-managment/_category_.json index b24aa138b..b62036ddb 100644 --- a/docs/ru/md/Bitrix24/File-managment/_category_.json +++ b/docs/ru/md/Bitrix24/File-managment/_category_.json @@ -1,4 +1,4 @@ { "label": "Работа с файлами", -"position": "11" +"position": "12" } \ No newline at end of file diff --git a/docs/ru/md/Bitrix24/Kanban/_category_.json b/docs/ru/md/Bitrix24/Kanban/_category_.json index c198abbab..098d5fb33 100644 --- a/docs/ru/md/Bitrix24/Kanban/_category_.json +++ b/docs/ru/md/Bitrix24/Kanban/_category_.json @@ -1,4 +1,4 @@ { "label": "Канбан", -"position": "7" +"position": "8" } \ No newline at end of file diff --git a/docs/ru/md/Bitrix24/Message-management/_category_.json b/docs/ru/md/Bitrix24/Message-management/_category_.json index 5f94ed786..e5375b7d9 100644 --- a/docs/ru/md/Bitrix24/Message-management/_category_.json +++ b/docs/ru/md/Bitrix24/Message-management/_category_.json @@ -1,4 +1,4 @@ { "label": "Работа с сообщениями", -"position": "13" +"position": "14" } \ No newline at end of file diff --git a/docs/ru/md/Bitrix24/Notifications-managment/Create-personal-notification.md b/docs/ru/md/Bitrix24/Notifications-managment/Create-personal-notification.md new file mode 100644 index 000000000..8138ffe38 --- /dev/null +++ b/docs/ru/md/Bitrix24/Notifications-managment/Create-personal-notification.md @@ -0,0 +1,79 @@ +--- +sidebar_position: 1 +--- + +# Создать персональное уведомление + Создает персональное уведомление пользователю + + + +`Функция СоздатьПерсональноеУведомление(Знач URL, Знач IDПользователя, Знач Текст, Знач Тег = "", Знач Вложения = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПользователя | --user | Строка, Число | ID пользователя для отправки уведомления | + | Текст | --text | Строка | Текст уведомления | + | Тег | --tag | Строка | Тег уникальности Если уже существет, то другие увед. будут удалены | + | Вложения | --blocks | Массив из Структура | Массив блоков вложений | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.notify.personal.add](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=12129) +::: +
+ + +```bsl title="Пример кода" + IDПользователя = 1; + + URL = ПараметрыФункции["Bitrix24_URL"]; + Текст = "Текст сообщения"; + Картинка = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg"; + Файл = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx"; + + Вложения = Новый Массив; + Вложения.Добавить(OPI_Bitrix24.ПолучитьБлокКартинки("Картинка1", Картинка)); + Вложения.Добавить(OPI_Bitrix24.ПолучитьБлокФайла("Файл1.docx" , Файл)); + + Результат = OPI_Bitrix24.СоздатьПерсональноеУведомление(URL, IDПользователя, Текст, ,Вложения); + + + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + Тег = "Новый"; + IDПользователя = 10; + + Результат = OPI_Bitrix24.СоздатьПерсональноеУведомление(URL, IDПользователя, Текст, Тег, , Токен); +``` + + + +```sh title="Пример команды CLI" + +oint bitrix24 СоздатьПерсональноеУведомление --url %url% --user %user% --text %text% --tag %tag% --blocks %blocks% --token %token% + +``` + +```json title="Результат" +{ + "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 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Notifications-managment/Create-system-notification.md b/docs/ru/md/Bitrix24/Notifications-managment/Create-system-notification.md new file mode 100644 index 000000000..13661512c --- /dev/null +++ b/docs/ru/md/Bitrix24/Notifications-managment/Create-system-notification.md @@ -0,0 +1,79 @@ +--- +sidebar_position: 2 +--- + +# Создать системное уведомление + Создает системное уведомление пользователю + + + +`Функция СоздатьСистемноеУведомление(Знач URL, Знач IDПользователя, Знач Текст, Знач Тег = "", Знач Вложения = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПользователя | --user | Строка, Число | ID пользователя для отправки уведомления | + | Текст | --text | Строка | Текст уведомления | + | Тег | --tag | Строка | Тег уникальности Если уже существет, то другие увед. будут удалены | + | Вложения | --blocks | Массив из Структура | Массив блоков вложений | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.notify.system.add](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=12131) +::: +
+ + +```bsl title="Пример кода" + IDПользователя = 1; + + URL = ПараметрыФункции["Bitrix24_URL"]; + Текст = "Текст сообщения"; + Картинка = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg"; + Файл = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx"; + + Вложения = Новый Массив; + Вложения.Добавить(OPI_Bitrix24.ПолучитьБлокКартинки("Картинка1", Картинка)); + Вложения.Добавить(OPI_Bitrix24.ПолучитьБлокФайла("Файл1.docx" , Файл)); + + Результат = OPI_Bitrix24.СоздатьСистемноеУведомление(URL, IDПользователя, Текст, ,Вложения); + + + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + Тег = "Новый"; + IDПользователя = 10; + + Результат = OPI_Bitrix24.СоздатьСистемноеУведомление(URL, IDПользователя, Текст, Тег, , Токен); +``` + + + +```sh title="Пример команды CLI" + +oint bitrix24 СоздатьСистемноеУведомление --url %url% --user %user% --text %text% --tag %tag% --blocks %blocks% --token %token% + +``` + +```json title="Результат" +{ + "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 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Notifications-managment/Delete-notification.md b/docs/ru/md/Bitrix24/Notifications-managment/Delete-notification.md new file mode 100644 index 000000000..f604d169e --- /dev/null +++ b/docs/ru/md/Bitrix24/Notifications-managment/Delete-notification.md @@ -0,0 +1,66 @@ +--- +sidebar_position: 3 +--- + +# Удалить уведомление + Удаляет уведомление по ID + + + +`Функция УдалитьУведомление(Знач URL, Знач IDУведомления, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDУведомления | --notif | Строка, Число | ID уведомления для удаления | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.notify.delete](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=12133) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + IDУведомления = ПараметрыФункции["Bitrix24_PersoalHookNotifyID"]; + + Результат = OPI_Bitrix24.УдалитьУведомление(URL, IDУведомления); + + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDУведомления = ПараметрыФункции["Bitrix24_PersoalNotifyID"]; + + Результат = OPI_Bitrix24.УдалитьУведомление(URL, IDУведомления, Токен); +``` + + + +```sh title="Пример команды CLI" + +oint bitrix24 УдалитьУведомление --url %url% --notif %notif% --token %token% + +``` + +```json title="Результат" +{ + "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 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Notifications-managment/_category_.json b/docs/ru/md/Bitrix24/Notifications-managment/_category_.json new file mode 100644 index 000000000..11f22f2e8 --- /dev/null +++ b/docs/ru/md/Bitrix24/Notifications-managment/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Работа с уведомлениями", +"position": "15" +} \ No newline at end of file diff --git a/docs/ru/md/Bitrix24/Storages-managment/_category_.json b/docs/ru/md/Bitrix24/Storages-managment/_category_.json index 67a1ee0e8..82985c451 100644 --- a/docs/ru/md/Bitrix24/Storages-managment/_category_.json +++ b/docs/ru/md/Bitrix24/Storages-managment/_category_.json @@ -1,4 +1,4 @@ { "label": "Работа с хранилищами", -"position": "9" +"position": "10" } \ No newline at end of file diff --git a/docs/ru/md/Bitrix24/Tasks-checklists-managment/_category_.json b/docs/ru/md/Bitrix24/Tasks-checklists-managment/_category_.json index ce756bd81..74e5af12d 100644 --- a/docs/ru/md/Bitrix24/Tasks-checklists-managment/_category_.json +++ b/docs/ru/md/Bitrix24/Tasks-checklists-managment/_category_.json @@ -1,4 +1,4 @@ { "label": "Работа с чеклистами задач", -"position": "5" +"position": "6" } \ No newline at end of file diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Get-tasks-filter-structure.md b/docs/ru/md/Bitrix24/Tasks-managment/Get-tasks-filter-structure.md index 3755056e0..21afcd651 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Get-tasks-filter-structure.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Get-tasks-filter-structure.md @@ -14,7 +14,7 @@ sidebar_position: 27 | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания полей | - Возвращаемое значение: Структура Из КлючИЗначение - Структура полей + Возвращаемое значение: Структура Из КлючИЗначение - Структура полей
diff --git a/docs/ru/md/Bitrix24/Timekeeping/Get-timekeeping-settings.md b/docs/ru/md/Bitrix24/Timekeeping/Get-timekeeping-settings.md new file mode 100644 index 000000000..07d254058 --- /dev/null +++ b/docs/ru/md/Bitrix24/Timekeeping/Get-timekeeping-settings.md @@ -0,0 +1,73 @@ +--- +sidebar_position: 10 +--- + +# Получить настройки учета времени + Получает настройки учета времени пользователя + + + +`Функция ПолучитьНастройкиУчетаВремени(Знач URL, Знач IDПользователя = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПользователя | --userid | Строка, Число | ID пользователя для учета. Текущий по умолчанию | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [timeman.settings](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_settings.php) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + + Результат = OPI_Bitrix24.ПолучитьНастройкиУчетаВремени(URL); + + Час = 3600; + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDПользователя = 1; + + Результат = OPI_Bitrix24.ПолучитьНастройкиУчетаВремени(URL, IDПользователя); +``` + + + +```sh title="Пример команды CLI" + +oint bitrix24 ПолучитьНастройкиУчетаВремени --url %url% --userid %userid% --token %token% + +``` + +```json title="Результат" +{ + "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 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Timekeeping/Get-timekeeping-status.md b/docs/ru/md/Bitrix24/Timekeeping/Get-timekeeping-status.md new file mode 100644 index 000000000..6d321de4e --- /dev/null +++ b/docs/ru/md/Bitrix24/Timekeeping/Get-timekeeping-status.md @@ -0,0 +1,79 @@ +--- +sidebar_position: 9 +--- + +# Получить статус учета времени + Получает статус учета времени пользователя + + + +`Функция ПолучитьСтатусУчетаВремени(Знач URL, Знач IDПользователя = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПользователя | --userid | Строка, Число | ID пользователя для учета. Текущий по умолчанию | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [timeman.status](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_status.php) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + + Результат = OPI_Bitrix24.ПолучитьСтатусУчетаВремени(URL); + + Час = 3600; + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDПользователя = 1; + + Результат = OPI_Bitrix24.ПолучитьСтатусУчетаВремени(URL, IDПользователя); +``` + + + +```sh title="Пример команды CLI" + +oint bitrix24 ПолучитьСтатусУчетаВремени --url %url% --userid %userid% --token %token% + +``` + +```json title="Результат" +{ + "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 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Timekeeping/Pause-timekeeping.md b/docs/ru/md/Bitrix24/Timekeeping/Pause-timekeeping.md new file mode 100644 index 000000000..3100fa327 --- /dev/null +++ b/docs/ru/md/Bitrix24/Timekeeping/Pause-timekeeping.md @@ -0,0 +1,79 @@ +--- +sidebar_position: 8 +--- + +# Приостановить учет времени + Приостанавливает учет времени пользователя + + + +`Функция ПриостановитьУчетВремени(Знач URL, Знач IDПользователя = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПользователя | --userid | Строка, Число | ID пользователя для учета. Текущий по умолчанию | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [timeman.pause](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_pause.php) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + + Результат = OPI_Bitrix24.ПриостановитьУчетВремени(URL); + + Час = 3600; + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDПользователя = 1; + + Результат = OPI_Bitrix24.ПриостановитьУчетВремени(URL, IDПользователя); +``` + + + +```sh title="Пример команды CLI" + +oint bitrix24 ПриостановитьУчетВремени --url %url% --userid %userid% --token %token% + +``` + +```json title="Результат" +{ + "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 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Timekeeping/Start-timekeeping.md b/docs/ru/md/Bitrix24/Timekeeping/Start-timekeeping.md new file mode 100644 index 000000000..5d83b1b11 --- /dev/null +++ b/docs/ru/md/Bitrix24/Timekeeping/Start-timekeeping.md @@ -0,0 +1,83 @@ +--- +sidebar_position: 6 +--- + +# Начать учет времени + Начинает учет времени пользователя + + + +`Функция НачатьУчетВремени(Знач URL, Знач IDПользователя = "", Знач Время = "", Знач Отчет = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПользователя | --userid | Строка, Число | ID пользователя для учета. Текущий по умолчанию | + | Время | --time | Дата | Время начала учета. Дата должна совпадать с текущей. Текущее время по ум. | + | Отчет | --report | Строка | Причина изменения. Обязателен при указании Время и отключенном свободном графике | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [timeman.open](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_open.php) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + + Результат = OPI_Bitrix24.НачатьУчетВремени(URL); + + Час = 3600; + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDПользователя = 1; + Время = OPI_Инструменты.ПолучитьТекущуюДату() - Час; + Отчет = "Опоздание"; + + Результат = OPI_Bitrix24.НачатьУчетВремени(URL, IDПользователя, Время, Отчет, ); +``` + + + +```sh title="Пример команды CLI" + +oint bitrix24 НачатьУчетВремени --url %url% --userid %userid% --time %time% --report %report% --token %token% + +``` + +```json title="Результат" +{ + "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 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Timekeeping/Stop-timekeeping.md b/docs/ru/md/Bitrix24/Timekeeping/Stop-timekeeping.md new file mode 100644 index 000000000..ff3d3db52 --- /dev/null +++ b/docs/ru/md/Bitrix24/Timekeeping/Stop-timekeeping.md @@ -0,0 +1,58 @@ +--- +sidebar_position: 7 +--- + +# Завершить учет времени + Завершает учет времени пользователя + + + +`Функция ЗавершитьУчетВремени(Знач URL, Знач IDПользователя = "", Знач Время = "", Знач Отчет = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПользователя | --userid | Строка, Число | ID пользователя для учета. Текущий по умолчанию | + | Время | --time | Дата | Время заверш. учета. Дата должна совпадать с текущей. Текущее время по ум. | + | Отчет | --report | Строка | Причина изменения. Обязателен при указании Время и отключенном свободном графике | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [timeman.close](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_close.php) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + + Результат = OPI_Bitrix24.ЗавершитьУчетВремени(URL); + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDПользователя = 1; + Время = OPI_Инструменты.ПолучитьТекущуюДату(); + Отчет = "Отгул"; + + Результат = OPI_Bitrix24.ЗавершитьУчетВремени(URL, IDПользователя, Время, Отчет, ); +``` + + + +```sh title="Пример команды CLI" + +oint bitrix24 ЗавершитьУчетВремени --url %url% --userid %userid% --time %time% --report %report% --token %token% + +``` + +```json title="Результат" +{ + "error": "WRONG_DATETIME_FORMAT", + "error_description": "Wrong datetime format" +} +``` diff --git a/docs/ru/md/Bitrix24/Timekeeping/_category_.json b/docs/ru/md/Bitrix24/Timekeeping/_category_.json index 03cdb8aa1..71b3cd3da 100644 --- a/docs/ru/md/Bitrix24/Timekeeping/_category_.json +++ b/docs/ru/md/Bitrix24/Timekeeping/_category_.json @@ -1,4 +1,4 @@ { "label": "Учет рабочего времени", -"position": "8" +"position": "9" } \ No newline at end of file diff --git a/docs/ru/md/Bitrix24/Users-managment/Change-user-status.md b/docs/ru/md/Bitrix24/Users-managment/Change-user-status.md new file mode 100644 index 000000000..e8850d69c --- /dev/null +++ b/docs/ru/md/Bitrix24/Users-managment/Change-user-status.md @@ -0,0 +1,64 @@ +--- +sidebar_position: 5 +--- + +# Изменить статус пользователя + Активирует или деактивирует (увольняет) выбранного пользователя + + + +`Функция ИзменитьСтатусПользователя(Знач URL, Знач IDПользователя, Знач Уволить = Истина, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПользователя | --userid | Строка, Число | ID пользователя для изменения | + | Уволить | --fire | Булево | Истина > Деактивация, Ложь > Активация | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ + + + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + IDПользователя = ПараметрыФункции["Bitrix24_HookUserID"]; + + Результат = OPI_Bitrix24.ИзменитьСтатусПользователя(URL, IDПользователя, Истина); + + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDПользователя = ПараметрыФункции["Bitrix24_UserID"]; + + Результат = OPI_Bitrix24.ИзменитьСтатусПользователя(URL, IDПользователя, Истина, Токен); +``` + + + +```sh title="Пример команды CLI" + +oint bitrix24 ИзменитьСтатусПользователя --url %url% --userid %userid% --fire %fire% --token %token% + +``` + +```json title="Результат" +{ + "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 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Users-managment/Create-user.md b/docs/ru/md/Bitrix24/Users-managment/Create-user.md new file mode 100644 index 000000000..b2e9b9cca --- /dev/null +++ b/docs/ru/md/Bitrix24/Users-managment/Create-user.md @@ -0,0 +1,83 @@ +--- +sidebar_position: 3 +--- + +# Создать пользователя + Создает нового пользователя по структуре полей + + + +`Функция СоздатьПользователя(Знач URL, Знач СтруктураПолей, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | СтруктураПолей | --fields | Структура Из КлючИЗначение | Данные пользователя. См. ПолучитьСтурктуруПользователя | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [user.add](https://dev.1c-bitrix.ru/rest_help/users/user_add.php) + + Если нужно добавить пользователя экстранета, то в полях необходимо передать: EXTRANET: Y и SONET_GROUP_ID: [...] + + Если нужно добавить пользователя интранета, то обязательно передаётся: UF_DEPARTMENT: [...] +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + Почта = Строка(Новый УникальныйИдентификатор) + "@exepmple.org"; + // Полную структуру можно получить функцией ПолучитьСтурктуруПользователя + + СтруктураПользователя = Новый Структура; + СтруктураПользователя.Вставить("EMAIL" , Почта); + СтруктураПользователя.Вставить("UF_DEPARTMENT", 7); + + Результат = OPI_Bitrix24.СоздатьПользователя(URL, СтруктураПользователя); + + + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + Почта = Строка(Новый УникальныйИдентификатор) + "@exepmple.org"; + + СтруктураПользователя = Новый Структура; + СтруктураПользователя.Вставить("EMAIL" , Почта); + СтруктураПользователя.Вставить("NAME" , "Виталий"); + СтруктураПользователя.Вставить("LAST_NAME" , "Альпака"); + СтруктураПользователя.Вставить("PERSONAL_MOBILE", "88003553535"); + СтруктураПользователя.Вставить("UF_DEPARTMENT" , 1); + + Результат = OPI_Bitrix24.СоздатьПользователя(URL, СтруктураПользователя, Токен); +``` + + + +```sh title="Пример команды CLI" + +oint bitrix24 СоздатьПользователя --url %url% --fields %fields% --token %token% + +``` + +```json title="Результат" +{ + "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 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Users-managment/Find-users.md b/docs/ru/md/Bitrix24/Users-managment/Find-users.md new file mode 100644 index 000000000..dbbc6824c --- /dev/null +++ b/docs/ru/md/Bitrix24/Users-managment/Find-users.md @@ -0,0 +1,279 @@ +--- +sidebar_position: 6 +--- + +# Найти пользователей + Получает список пользователей по заданному фильтру + + + +`Функция НайтиПользователей(Знач URL, Знач СтруктураФильтра, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | СтруктураФильтра | --filter | Структура Из КлючИЗначение | Фильтр. См. ПолучитьСтруктуруФильтраПользователей | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [user.update](https://dev.1c-bitrix.ru/rest_help/users/user_update.php) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + + СтруктураФильтра = Новый Структура; + СтруктураФильтра.Вставить("NAME" , "Виталий"); + СтруктураФильтра.Вставить("LAST_NAME" , "Альпака"); + СтруктураФильтра.Вставить("WORK_POSITION" , "DevOps инженер"); + СтруктураФильтра.Вставить("UF_DEPARTMENT_NAME", "Отдел маркетинга"); + СтруктураФильтра.Вставить("USER_TYPE" , "employee"); + + Результат = OPI_Bitrix24.НайтиПользователей(URL, СтруктураФильтра); + + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + + СтруктураФильтра = Новый Структура; + СтруктураФильтра.Вставить("UF_DEPARTMENT_NAME", "Битрикс"); + + Результат = OPI_Bitrix24.НайтиПользователей(URL, СтруктураФильтра, Токен); +``` + + + +```sh title="Пример команды CLI" + +oint bitrix24 НайтиПользователей --url %url% --filter %filter% --token %token% + +``` + +```json title="Результат" +{ + "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": "Антон", + "LAST_NAME": "Титовец", + "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": "Виталий", + "LAST_NAME": "Альпака", + "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 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Users-managment/Get-current-user.md b/docs/ru/md/Bitrix24/Users-managment/Get-current-user.md new file mode 100644 index 000000000..c806e9490 --- /dev/null +++ b/docs/ru/md/Bitrix24/Users-managment/Get-current-user.md @@ -0,0 +1,84 @@ +--- +sidebar_position: 1 +--- + +# Получить текущего пользователя + Получает информацию о текущем пользователе + + + +`Функция ПолучитьТекущегоПользователя(Знач URL, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [user.current](https://dev.1c-bitrix.ru/rest_help/users/user_current.php) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + + Результат = OPI_Bitrix24.ПолучитьТекущегоПользователя(URL); + + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + + Результат = OPI_Bitrix24.ПолучитьТекущегоПользователя(URL, Токен); +``` + + + +```sh title="Пример команды CLI" + +oint bitrix24 ПолучитьТекущегоПользователя --url %url% --token %token% + +``` + +```json title="Результат" +{ + "result": { + "ID": "1", + "XML_ID": "53818298", + "ACTIVE": true, + "NAME": "Антон", + "LAST_NAME": "Титовец", + "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 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Users-managment/Get-user-fields-structure.md b/docs/ru/md/Bitrix24/Users-managment/Get-user-fields-structure.md new file mode 100644 index 000000000..f777f9328 --- /dev/null +++ b/docs/ru/md/Bitrix24/Users-managment/Get-user-fields-structure.md @@ -0,0 +1,128 @@ +--- +sidebar_position: 7 +--- + +# Получить стурктуру пользователя + Получает структурау полей для создания или изменения пользователя + + + +`Функция ПолучитьСтурктуруПользователя(Знач URL, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [user.fields](https://dev.1c-bitrix.ru/rest_help/users/user_fields.php) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + + Результат = OPI_Bitrix24.ПолучитьСтурктуруПользователя(URL); + + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + + Результат = OPI_Bitrix24.ПолучитьСтурктуруПользователя(URL, Токен); +``` + + + +```sh title="Пример команды CLI" + +oint bitrix24 ПолучитьСтурктуруПользователя --url %url% --token %token% + +``` + +```json title="Результат" +{ + "result": { + "ID": "ID", + "XML_ID": "Внешний код", + "ACTIVE": "Активность", + "NAME": "Имя", + "LAST_NAME": "Фамилия", + "SECOND_NAME": "Отчество", + "TITLE": "Список пользователей", + "EMAIL": "E-Mail", + "LAST_LOGIN": "Последняя авторизация", + "DATE_REGISTER": "Дата регистрации", + "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": "Пол", + "PERSONAL_PROFESSION": "Профессия", + "PERSONAL_WWW": "Домашняя страничка", + "PERSONAL_BIRTHDAY": "Дата рождения", + "PERSONAL_PHOTO": "Фотография", + "PERSONAL_ICQ": "ICQ", + "PERSONAL_PHONE": "Личный телефон", + "PERSONAL_FAX": "Факс", + "PERSONAL_MOBILE": "Личный мобильный", + "PERSONAL_PAGER": "Пейджер", + "PERSONAL_STREET": "Улица проживания", + "PERSONAL_CITY": "Город проживания", + "PERSONAL_STATE": "Область / край", + "PERSONAL_ZIP": "Почтовый индекс", + "PERSONAL_COUNTRY": "Страна", + "PERSONAL_MAILBOX": "Почтовый ящик", + "PERSONAL_NOTES": "Дополнительные заметки", + "WORK_PHONE": "Телефон компании", + "WORK_COMPANY": "Компания", + "WORK_POSITION": "Должность", + "WORK_DEPARTMENT": "Отдел", + "WORK_WWW": "Сайт компании", + "WORK_FAX": "WORK_FAX", + "WORK_PAGER": "WORK_PAGER", + "WORK_STREET": "WORK_STREET", + "WORK_MAILBOX": "WORK_MAILBOX", + "WORK_CITY": "Город работы", + "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": "Ссылка на чат в Skype", + "UF_ZOOM": "Zoom", + "UF_EMPLOYMENT_DATE": "Дата принятия на работу", + "UF_TIMEMAN": "Учет рабочего времени", + "UF_DEPARTMENT": "Подразделения", + "UF_INTERESTS": "Интересы", + "UF_SKILLS": "Навыки", + "UF_WEB_SITES": "Другие сайты", + "UF_XING": "Xing", + "UF_LINKEDIN": "LinkedIn", + "UF_FACEBOOK": "Facebook", + "UF_TWITTER": "Twitter", + "UF_SKYPE": "Skype", + "UF_DISTRICT": "Район", + "UF_PHONE_INNER": "Внутренний телефон", + "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 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Users-managment/Get-user-filter-structure.md b/docs/ru/md/Bitrix24/Users-managment/Get-user-filter-structure.md new file mode 100644 index 000000000..84c5d6ed8 --- /dev/null +++ b/docs/ru/md/Bitrix24/Users-managment/Get-user-filter-structure.md @@ -0,0 +1,33 @@ +--- +sidebar_position: 8 +--- + +# Получить структуру фильтра пользователей + Возвращает структуру полей для фильтрации пользователей в методе НайтиПользователей + + + +`Функция ПолучитьСтруктуруФильтраПользователей(Знач Пустая = Ложь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания полей | + + + Возвращаемое значение: Структура Из КлючИЗначение - Структура полей + +
+ + + + + + + +```sh title="Пример команды CLI" + +oint bitrix24 ПолучитьСтруктуруФильтраПользователей --empty %empty% + +``` + + diff --git a/docs/ru/md/Bitrix24/Users-managment/Get-user.md b/docs/ru/md/Bitrix24/Users-managment/Get-user.md new file mode 100644 index 000000000..d732d6c22 --- /dev/null +++ b/docs/ru/md/Bitrix24/Users-managment/Get-user.md @@ -0,0 +1,88 @@ +--- +sidebar_position: 2 +--- + +# Получить пользователя + Получает информацию о пользователе по ID + + + +`Функция ПолучитьПользователя(Знач URL, Знач IDПользователя, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПользователя | --userid | Строка, Число | ID пользователя для получения | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [user.get](https://dev.1c-bitrix.ru/rest_help/users/user_get.php) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + IDПользователя = ПараметрыФункции["Bitrix24_HookUserID"]; + + Результат = OPI_Bitrix24.ПолучитьПользователя(URL, IDПользователя); + + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDПользователя = ПараметрыФункции["Bitrix24_UserID"]; + + Результат = OPI_Bitrix24.ПолучитьПользователя(URL, IDПользователя, Токен); +``` + + + +```sh title="Пример команды CLI" + +oint bitrix24 ПолучитьПользователя --url %url% --userid %userid% --token %token% + +``` + +```json title="Результат" +{ + "result": [ + { + "ID": "60", + "XML_ID": "56731232", + "ACTIVE": true, + "NAME": "Олег", + "LAST_NAME": "Лама", + "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 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Users-managment/Update-user.md b/docs/ru/md/Bitrix24/Users-managment/Update-user.md new file mode 100644 index 000000000..f0500f391 --- /dev/null +++ b/docs/ru/md/Bitrix24/Users-managment/Update-user.md @@ -0,0 +1,81 @@ +--- +sidebar_position: 4 +--- + +# Изменить пользователя + Изменяет данные пользователя + + + +`Функция ИзменитьПользователя(Знач URL, Знач IDПользователя, Знач СтруктураПолей, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПользователя | --userid | Строка, Число | ID пользователя для изменения | + | СтруктураПолей | --fields | Структура Из КлючИЗначение | Данные пользователя. См. ПолучитьСтурктуруПользователя | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [user.update](https://dev.1c-bitrix.ru/rest_help/users/user_update.php) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + IDПользователя = ПараметрыФункции["Bitrix24_HookUserID"]; + Почта = Строка(Новый УникальныйИдентификатор) + "@exepmple.org"; + + // Полную структуру можно получить функцией ПолучитьСтурктуруПользователя + + СтруктураПользователя = Новый Структура; + СтруктураПользователя.Вставить("EMAIL" , Почта); + СтруктураПользователя.Вставить("UF_DEPARTMENT", 1); + + Результат = OPI_Bitrix24.ИзменитьПользователя(URL, IDПользователя, СтруктураПользователя); + + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDПользователя = ПараметрыФункции["Bitrix24_UserID"]; + Почта = Строка(Новый УникальныйИдентификатор) + "@exepmple.org"; + + СтруктураПользователя = Новый Структура; + СтруктураПользователя.Вставить("EMAIL" , Почта); + СтруктураПользователя.Вставить("NAME" , "Олег"); + СтруктураПользователя.Вставить("LAST_NAME" , "Лама"); + СтруктураПользователя.Вставить("UF_DEPARTMENT" , 7); + + Результат = OPI_Bitrix24.ИзменитьПользователя(URL, IDПользователя, СтруктураПользователя, Токен); +``` + + + +```sh title="Пример команды CLI" + +oint bitrix24 ИзменитьПользователя --url %url% --userid %userid% --fields %fields% --token %token% + +``` + +```json title="Результат" +{ + "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 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Users-managment/_category_.json b/docs/ru/md/Bitrix24/Users-managment/_category_.json new file mode 100644 index 000000000..54bc5a0f4 --- /dev/null +++ b/docs/ru/md/Bitrix24/Users-managment/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Управление пользователями", +"position": "17" +} \ No newline at end of file diff --git a/docs/ru/md/Dropbox/File-and-directory-management/Get-object-information.md b/docs/ru/md/Dropbox/File-and-directory-management/Get-object-information.md index 4a9d747bd..0e4d142a2 100644 --- a/docs/ru/md/Dropbox/File-and-directory-management/Get-object-information.md +++ b/docs/ru/md/Dropbox/File-and-directory-management/Get-object-information.md @@ -16,7 +16,7 @@ sidebar_position: 1 | Подробно | --detail | Булево | Добавляет дополнительные поля информации для медиафайлов | - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox
diff --git a/docs/ru/md/Dropbox/File-and-directory-management/Get-preview.md b/docs/ru/md/Dropbox/File-and-directory-management/Get-preview.md index dbc2402a6..01a0bca33 100644 --- a/docs/ru/md/Dropbox/File-and-directory-management/Get-preview.md +++ b/docs/ru/md/Dropbox/File-and-directory-management/Get-preview.md @@ -15,7 +15,7 @@ sidebar_position: 3 | Путь | --path | Строка | Путь к объекту | - Возвращаемое значение: ДвоичныеДанные - превью документа + Возвращаемое значение: ДвоичныеДанные - превью документа
diff --git a/docs/ru/md/Dropbox/File-and-directory-management/Upload-file.md b/docs/ru/md/Dropbox/File-and-directory-management/Upload-file.md index e13964b3e..acbd95428 100644 --- a/docs/ru/md/Dropbox/File-and-directory-management/Upload-file.md +++ b/docs/ru/md/Dropbox/File-and-directory-management/Upload-file.md @@ -17,7 +17,7 @@ sidebar_position: 4 | Перезаписывать | --overwrite | Булево | Перезаписывать файл при конфликте путей | - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox
diff --git a/docs/ru/md/Slack/Management-and-settings/Get-bot-information.md b/docs/ru/md/Slack/Management-and-settings/Get-bot-information.md index e4abc483b..e76cf614e 100644 --- a/docs/ru/md/Slack/Management-and-settings/Get-bot-information.md +++ b/docs/ru/md/Slack/Management-and-settings/Get-bot-information.md @@ -14,7 +14,7 @@ sidebar_position: 1 | Токен | --token | Строка | Токен бота | - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack
diff --git a/docs/ru/md/Telegram/Data-sending/Send-document.md b/docs/ru/md/Telegram/Data-sending/Send-document.md index 9e4f6c0a0..2dfa34862 100644 --- a/docs/ru/md/Telegram/Data-sending/Send-document.md +++ b/docs/ru/md/Telegram/Data-sending/Send-document.md @@ -7,7 +7,7 @@ sidebar_position: 5 -`Функция ОтправитьДокумент(Знач Токен, Знач IDЧата, Знач Текст, Знач Документ, Знач Клавиатура = "", Знач Разметка = "Markdown") Экспорт` +`Функция ОтправитьДокумент(Знач Токен, Знач IDЧата, Знач Текст, Знач Документ, Знач Клавиатура = "", Знач Разметка = "Markdown", Знач ИмяФайла = "") Экспорт` | Параметр | CLI опция | Тип | Назначение | |-|-|-|-| @@ -17,6 +17,7 @@ sidebar_position: 5 | Документ | --doc | ДвоичныеДанные,Строка | Файл документа | | Клавиатура | --keyboard | Строка | JSON клавиатуры или путь к .json | | Разметка | --parsemode | Строка | Вид обработки текста (HTML, Markdown, MarkdownV2) | + | ИмяФайла | --filename | Строка | Отображаемое имя файла c расширением, если необходимо | Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram diff --git a/docs/ru/md/Telegram/Data-sending/Send-media-group.md b/docs/ru/md/Telegram/Data-sending/Send-media-group.md index 72c657fdb..3da2af437 100644 --- a/docs/ru/md/Telegram/Data-sending/Send-media-group.md +++ b/docs/ru/md/Telegram/Data-sending/Send-media-group.md @@ -23,7 +23,10 @@ sidebar_position: 7
- +:::tip +Соответствие файлов: Ключ - Файл, Значение - один из типов медиа +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/VK/Community-managment/Upload-photo-to-server.md b/docs/ru/md/VK/Community-managment/Upload-photo-to-server.md index 55182f6c7..aa65bd062 100644 --- a/docs/ru/md/VK/Community-managment/Upload-photo-to-server.md +++ b/docs/ru/md/VK/Community-managment/Upload-photo-to-server.md @@ -16,7 +16,7 @@ sidebar_position: 11 | Вид | --type | Строка | Вид загрузки (Пост, Товар, История, Опрос, Прочее) | - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK
diff --git a/docs/ru/md/VK/Community-managment/Upload-video-to-server.md b/docs/ru/md/VK/Community-managment/Upload-video-to-server.md index 83dd694ed..b1ce92d2a 100644 --- a/docs/ru/md/VK/Community-managment/Upload-video-to-server.md +++ b/docs/ru/md/VK/Community-managment/Upload-video-to-server.md @@ -18,7 +18,7 @@ sidebar_position: 10 | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK
diff --git a/docs/ru/md/VK/Interactive-actions/Shorten-link.md b/docs/ru/md/VK/Interactive-actions/Shorten-link.md index b2cb52705..86bea8c1c 100644 --- a/docs/ru/md/VK/Interactive-actions/Shorten-link.md +++ b/docs/ru/md/VK/Interactive-actions/Shorten-link.md @@ -15,7 +15,7 @@ sidebar_position: 5 | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - Возвращаемое значение: Строка - Сокращенный URL + Возвращаемое значение: Строка - Сокращенный URL
diff --git a/docs/ru/md/VK/Order-management/Get-order-list.md b/docs/ru/md/VK/Order-management/Get-order-list.md index 12010a966..eb809a32e 100644 --- a/docs/ru/md/VK/Order-management/Get-order-list.md +++ b/docs/ru/md/VK/Order-management/Get-order-list.md @@ -14,7 +14,7 @@ sidebar_position: 1 | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK
diff --git a/docs/ru/md/VK/Product-properties-management/Add-product-property-variant.md b/docs/ru/md/VK/Product-properties-management/Add-product-property-variant.md index cfd8ade23..2655f14a3 100644 --- a/docs/ru/md/VK/Product-properties-management/Add-product-property-variant.md +++ b/docs/ru/md/VK/Product-properties-management/Add-product-property-variant.md @@ -16,7 +16,7 @@ sidebar_position: 5 | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK
diff --git a/docs/ru/md/VK/Product-properties-management/Create-product-property.md b/docs/ru/md/VK/Product-properties-management/Create-product-property.md index 302f86b51..b5a56c1fe 100644 --- a/docs/ru/md/VK/Product-properties-management/Create-product-property.md +++ b/docs/ru/md/VK/Product-properties-management/Create-product-property.md @@ -15,7 +15,7 @@ sidebar_position: 2 | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK
diff --git a/docs/ru/md/VK/Product-properties-management/Delete-product-property-variant.md b/docs/ru/md/VK/Product-properties-management/Delete-product-property-variant.md index 98cdf58db..73ebc6d40 100644 --- a/docs/ru/md/VK/Product-properties-management/Delete-product-property-variant.md +++ b/docs/ru/md/VK/Product-properties-management/Delete-product-property-variant.md @@ -15,7 +15,7 @@ sidebar_position: 7 | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK
diff --git a/docs/ru/md/VK/Product-properties-management/Delete-product-property.md b/docs/ru/md/VK/Product-properties-management/Delete-product-property.md index 9bd371e9e..09e11e669 100644 --- a/docs/ru/md/VK/Product-properties-management/Delete-product-property.md +++ b/docs/ru/md/VK/Product-properties-management/Delete-product-property.md @@ -15,7 +15,7 @@ sidebar_position: 4 | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK
diff --git a/docs/ru/md/VK/Product-properties-management/Edit-product-property-variant.md b/docs/ru/md/VK/Product-properties-management/Edit-product-property-variant.md index 5d15acf9a..b287a0927 100644 --- a/docs/ru/md/VK/Product-properties-management/Edit-product-property-variant.md +++ b/docs/ru/md/VK/Product-properties-management/Edit-product-property-variant.md @@ -17,7 +17,7 @@ sidebar_position: 6 | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK
diff --git a/docs/ru/md/VK/Product-properties-management/Edit-product-property.md b/docs/ru/md/VK/Product-properties-management/Edit-product-property.md index a48ba89cd..04d76b7d6 100644 --- a/docs/ru/md/VK/Product-properties-management/Edit-product-property.md +++ b/docs/ru/md/VK/Product-properties-management/Edit-product-property.md @@ -16,7 +16,7 @@ sidebar_position: 3 | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK
diff --git a/docs/ru/md/VK/Product-properties-management/Get-property-list.md b/docs/ru/md/VK/Product-properties-management/Get-property-list.md index f265b7887..e8030c75b 100644 --- a/docs/ru/md/VK/Product-properties-management/Get-property-list.md +++ b/docs/ru/md/VK/Product-properties-management/Get-property-list.md @@ -14,7 +14,7 @@ sidebar_position: 1 | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK
diff --git a/docs/ru/md/VK/Token-retrieval/Create-token-retrieval-link.md b/docs/ru/md/VK/Token-retrieval/Create-token-retrieval-link.md index b0dfb33f4..593f63d05 100644 --- a/docs/ru/md/VK/Token-retrieval/Create-token-retrieval-link.md +++ b/docs/ru/md/VK/Token-retrieval/Create-token-retrieval-link.md @@ -14,7 +14,7 @@ sidebar_position: 1 | app_id | --app | Строка,Число | app_id из настроек приложения | - Возвращаемое значение: Строка - URL, по которому необходимо перейти в браузере + Возвращаемое значение: Строка - URL, по которому необходимо перейти в браузере
diff --git a/docs/ru/md/Yandex_Disk/File-and-folder-management/Upload-file.md b/docs/ru/md/Yandex_Disk/File-and-folder-management/Upload-file.md index 7df9e7aa4..279dc8965 100644 --- a/docs/ru/md/Yandex_Disk/File-and-folder-management/Upload-file.md +++ b/docs/ru/md/Yandex_Disk/File-and-folder-management/Upload-file.md @@ -17,7 +17,7 @@ sidebar_position: 10 | Перезаписывать | --rewrite | Булево | Перезаписывать, если файл с таким именем уже существует | - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex
diff --git a/docs/ru/md/Yandex_Disk/Manage-public-access/Publish-object.md b/docs/ru/md/Yandex_Disk/Manage-public-access/Publish-object.md index 5ae54133b..ae52880c1 100644 --- a/docs/ru/md/Yandex_Disk/Manage-public-access/Publish-object.md +++ b/docs/ru/md/Yandex_Disk/Manage-public-access/Publish-object.md @@ -15,7 +15,7 @@ sidebar_position: 1 | Путь | --path | Строка | Путь к публикуемому объекту | - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex