1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2025-11-29 22:27:42 +02:00

Main build (Jenkins)

This commit is contained in:
Vitaly the Alpaca (bot)
2024-11-21 22:39:27 +03:00
parent 34d354696c
commit 5cc51552f4
723 changed files with 7539 additions and 7539 deletions

View File

@@ -0,0 +1,88 @@
---
sidebar_position: 1
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Add tasks checklist element
Adds new element of tasks checklist
`Function AddTasksChecklistElement(Val URL, Val TaskID, Val Text, Val Completed = False, Token = "") Export`
| Parameter | CLI option | Type | Required | Description |
|-|-|-|-|-|
| URL | --url | String | ✔ | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | ✔ | Task ID |
| Text | --text | String | ✔ | Text (title) of checklist element |
| Completed | --complete | Boolean | ✖ | Mark as completed |
| Token | --token | String | ✖ | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.checklistitem.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/add.php)
:::
<br/>
```bsl title="1C:Enterprise/OneScript code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/yg2...";
TaskID = "3560";
Text = "Checklist element";
Result = OPI_Bitrix24.AddTasksChecklistElement(URL, TaskID, Text, True);
URL = "b24-ar17wx.bitrix24.by";
Token = "7afc3e67006e9f06006b12e400000001000...";
TaskID = "3562";
Result = OPI_Bitrix24.AddTasksChecklistElement(URL, TaskID, Text, , Token);
```
<Tabs>
<TabItem value="bash" label="Bash" default>
```bash
oint bitrix24 AddTasksChecklistElement \
--url "b24-ar17wx.bitrix24.by" \
--task "3592" \
--text "Checklist element" \
--token "***"
```
</TabItem>
<TabItem value="bat" label="CMD/Bat" default>
```batch
oint bitrix24 AddTasksChecklistElement ^
--url "b24-ar17wx.bitrix24.by" ^
--task "3592" ^
--text "Checklist element" ^
--token "***"
```
</TabItem>
</Tabs>
```json title="Result"
{
"result": 1460,
"time": {
"start": 1728454786.04734,
"finish": 1728454786.13143,
"duration": 0.0840880870819092,
"processing": 0.0545477867126465,
"date_start": "2024-10-09T09:19:46+03:00",
"date_finish": "2024-10-09T09:19:46+03:00",
"operating_reset_at": 1728455386,
"operating": 0
}
}
```

View File

@@ -0,0 +1,88 @@
---
sidebar_position: 6
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Complete tasks checklist element
Mark an element as completed
`Function CompleteTasksChecklistElement(Val URL, Val TaskID, Val ElementID, Val Token = "") Export`
| Parameter | CLI option | Type | Required | Description |
|-|-|-|-|-|
| URL | --url | String | &#x2714; | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | &#x2714; | Task ID |
| ElementID | --element | Number, String | &#x2714; | Element ID |
| Token | --token | String | &#x2716; | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.checklistitem.complete](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/complete.php)
:::
<br/>
```bsl title="1C:Enterprise/OneScript code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/yg2...";
TaskID = "3560";
ElementID = "2352";
Result = OPI_Bitrix24.CompleteTasksChecklistElement(URL, TaskID, ElementID);
TaskID = "3562";
ElementID = "2356";
URL = "b24-ar17wx.bitrix24.by";
Token = "7afc3e67006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.CompleteTasksChecklistElement(URL, TaskID, ElementID, Token);
```
<Tabs>
<TabItem value="bash" label="Bash" default>
```bash
oint bitrix24 CompleteTasksChecklistElement \
--url "b24-ar17wx.bitrix24.by" \
--task "3592" \
--element 2380 \
--token "***"
```
</TabItem>
<TabItem value="bat" label="CMD/Bat" default>
```batch
oint bitrix24 CompleteTasksChecklistElement ^
--url "b24-ar17wx.bitrix24.by" ^
--task "3592" ^
--element 2380 ^
--token "***"
```
</TabItem>
</Tabs>
```json title="Result"
{
"result": true,
"time": {
"start": 1728454787.01817,
"finish": 1728454787.07164,
"duration": 0.0534749031066894,
"processing": 0.0282580852508545,
"date_start": "2024-10-09T09:19:47+03:00",
"date_finish": "2024-10-09T09:19:47+03:00",
"operating_reset_at": 1728455387,
"operating": 0
}
}
```

View File

@@ -0,0 +1,88 @@
---
sidebar_position: 3
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Delete tasks checklist element
Deletes element from tasks checklist
`Function DeleteTasksChecklistElement(Val URL, Val TaskID, Val ElementID, Val Token = "") Export`
| Parameter | CLI option | Type | Required | Description |
|-|-|-|-|-|
| URL | --url | String | &#x2714; | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | &#x2714; | Task ID |
| ElementID | --element | Number, String | &#x2714; | ID of deleted element |
| Token | --token | String | &#x2716; | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.checklistitem.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/delete.php)
:::
<br/>
```bsl title="1C:Enterprise/OneScript code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/yg2...";
TaskID = "3560";
ElementID = "2352";
Result = OPI_Bitrix24.DeleteTasksChecklistElement(URL, TaskID, ElementID);
TaskID = "3562";
ElementID = "2356";
URL = "b24-ar17wx.bitrix24.by";
Token = "7afc3e67006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.DeleteTasksChecklistElement(URL, TaskID, ElementID, Token);
```
<Tabs>
<TabItem value="bash" label="Bash" default>
```bash
oint bitrix24 DeleteTasksChecklistElement \
--url "b24-ar17wx.bitrix24.by" \
--task "3592" \
--element 2380 \
--token "***"
```
</TabItem>
<TabItem value="bat" label="CMD/Bat" default>
```batch
oint bitrix24 DeleteTasksChecklistElement ^
--url "b24-ar17wx.bitrix24.by" ^
--task "3592" ^
--element 2380 ^
--token "***"
```
</TabItem>
</Tabs>
```json title="Result"
{
"result": true,
"time": {
"start": 1728454787.47564,
"finish": 1728454787.54389,
"duration": 0.0682549476623535,
"processing": 0.0366320610046387,
"date_start": "2024-10-09T09:19:47+03:00",
"date_finish": "2024-10-09T09:19:47+03:00",
"operating_reset_at": 1728455387,
"operating": 0
}
}
```

View File

@@ -0,0 +1,101 @@
---
sidebar_position: 5
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Get tasks checklist element
Gets tasks checklist element by ID
`Function GetTasksChecklistElement(Val URL, Val TaskID, Val ElementID, Val Token = "") Export`
| Parameter | CLI option | Type | Required | Description |
|-|-|-|-|-|
| URL | --url | String | &#x2714; | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | &#x2714; | Task ID |
| ElementID | --element | Number, String | &#x2714; | Element ID |
| Token | --token | String | &#x2716; | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.checklistitem.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/get.php)
:::
<br/>
```bsl title="1C:Enterprise/OneScript code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/yg2...";
TaskID = "3560";
ElementID = "2352";
Result = OPI_Bitrix24.GetTasksChecklistElement(URL, TaskID, ElementID);
TaskID = "3562";
ElementID = "2356";
URL = "b24-ar17wx.bitrix24.by";
Token = "7afc3e67006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetTasksChecklistElement(URL, TaskID, ElementID, Token);
```
<Tabs>
<TabItem value="bash" label="Bash" default>
```bash
oint bitrix24 GetTasksChecklistElement \
--url "b24-ar17wx.bitrix24.by" \
--task "3592" \
--element 2380 \
--token "***"
```
</TabItem>
<TabItem value="bat" label="CMD/Bat" default>
```batch
oint bitrix24 GetTasksChecklistElement ^
--url "b24-ar17wx.bitrix24.by" ^
--task "3592" ^
--element 2380 ^
--token "***"
```
</TabItem>
</Tabs>
```json title="Result"
{
"result": {
"ID": "1460",
"TASK_ID": "2398",
"PARENT_ID": "1458",
"CREATED_BY": "1",
"TITLE": "New elements text",
"SORT_INDEX": "1",
"IS_COMPLETE": "N",
"IS_IMPORTANT": "N",
"TOGGLED_BY": null,
"TOGGLED_DATE": "",
"MEMBERS": [],
"ATTACHMENTS": []
},
"time": {
"start": 1728454786.80187,
"finish": 1728454786.86049,
"duration": 0.0586211681365967,
"processing": 0.0263149738311768,
"date_start": "2024-10-09T09:19:46+03:00",
"date_finish": "2024-10-09T09:19:46+03:00",
"operating_reset_at": 1728455386,
"operating": 0
}
}
```

View File

@@ -0,0 +1,111 @@
---
sidebar_position: 4
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Get tasks checklist
Gets the list of elements on the task checklist
`Function GetTasksChecklist(Val URL, Val TaskID, Val Token = "") Export`
| Parameter | CLI option | Type | Required | Description |
|-|-|-|-|-|
| URL | --url | String | &#x2714; | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | &#x2714; | Task ID |
| Token | --token | String | &#x2716; | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.checklistitem.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/getlist.php)
:::
<br/>
```bsl title="1C:Enterprise/OneScript code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/yg2...";
TaskID = "3560";
Result = OPI_Bitrix24.GetTasksChecklist(URL, TaskID);
URL = "b24-ar17wx.bitrix24.by";
Token = "7afc3e67006e9f06006b12e400000001000...";
TaskID = "3562";
Result = OPI_Bitrix24.GetTasksChecklist(URL, TaskID, Token);
```
<Tabs>
<TabItem value="bash" label="Bash" default>
```bash
oint bitrix24 GetTasksChecklist \
--url "b24-ar17wx.bitrix24.by" \
--task "3592" \
--token "***"
```
</TabItem>
<TabItem value="bat" label="CMD/Bat" default>
```batch
oint bitrix24 GetTasksChecklist ^
--url "b24-ar17wx.bitrix24.by" ^
--task "3592" ^
--token "***"
```
</TabItem>
</Tabs>
```json title="Result"
{
"result": [
{
"ID": "1458",
"TASK_ID": "2398",
"PARENT_ID": 0,
"CREATED_BY": "1",
"TITLE": "BX_CHECKLIST_1",
"SORT_INDEX": "0",
"IS_COMPLETE": "N",
"IS_IMPORTANT": "N",
"TOGGLED_BY": null,
"TOGGLED_DATE": "",
"MEMBERS": [],
"ATTACHMENTS": []
},
{
"ID": "1460",
"TASK_ID": "2398",
"PARENT_ID": "1458",
"CREATED_BY": "1",
"TITLE": "New elements text",
"SORT_INDEX": "1",
"IS_COMPLETE": "N",
"IS_IMPORTANT": "N",
"TOGGLED_BY": null,
"TOGGLED_DATE": "",
"MEMBERS": [],
"ATTACHMENTS": []
}
],
"time": {
"start": 1728454786.58925,
"finish": 1728454786.64143,
"duration": 0.0521810054779053,
"processing": 0.0244979858398438,
"date_start": "2024-10-09T09:19:46+03:00",
"date_finish": "2024-10-09T09:19:46+03:00",
"operating_reset_at": 1728455386,
"operating": 0
}
}
```

View File

@@ -0,0 +1,88 @@
---
sidebar_position: 7
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Renew tasks checklist element
Unmark an element as completed
`Function RenewTasksChecklistElement(Val URL, Val TaskID, Val ElementID, Val Token = "") Export`
| Parameter | CLI option | Type | Required | Description |
|-|-|-|-|-|
| URL | --url | String | &#x2714; | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | &#x2714; | Task ID |
| ElementID | --element | Number, String | &#x2714; | Element ID |
| Token | --token | String | &#x2716; | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.checklistitem.renew](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/renew.php)
:::
<br/>
```bsl title="1C:Enterprise/OneScript code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/yg2...";
TaskID = "3560";
ElementID = "2352";
Result = OPI_Bitrix24.RenewTasksChecklistElement(URL, TaskID, ElementID);
TaskID = "3562";
ElementID = "2356";
URL = "b24-ar17wx.bitrix24.by";
Token = "7afc3e67006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.RenewTasksChecklistElement(URL, TaskID, ElementID, Token);
```
<Tabs>
<TabItem value="bash" label="Bash" default>
```bash
oint bitrix24 RenewTasksChecklistElement \
--url "b24-ar17wx.bitrix24.by" \
--task "3592" \
--element 2380 \
--token "***"
```
</TabItem>
<TabItem value="bat" label="CMD/Bat" default>
```batch
oint bitrix24 RenewTasksChecklistElement ^
--url "b24-ar17wx.bitrix24.by" ^
--task "3592" ^
--element 2380 ^
--token "***"
```
</TabItem>
</Tabs>
```json title="Result"
{
"result": true,
"time": {
"start": 1728454787.24722,
"finish": 1728454787.30494,
"duration": 0.0577118396759033,
"processing": 0.0310859680175781,
"date_start": "2024-10-09T09:19:47+03:00",
"date_finish": "2024-10-09T09:19:47+03:00",
"operating_reset_at": 1728455387,
"operating": 0
}
}
```

View File

@@ -0,0 +1,92 @@
---
sidebar_position: 2
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Update tasks checklist element
Updates text of element of tasks checklist
`Function UpdateTasksChecklistElement(Val URL, Val TaskID, Val ElementID, Val Text, Val Token = "") Export`
| Parameter | CLI option | Type | Required | Description |
|-|-|-|-|-|
| URL | --url | String | &#x2714; | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | &#x2714; | Task ID |
| ElementID | --element | Number, String | &#x2714; | Checklist element ID |
| Text | --text | String | &#x2714; | Text (title) of checklist element |
| Token | --token | String | &#x2716; | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.checklistitem.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/update.php)
:::
<br/>
```bsl title="1C:Enterprise/OneScript code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/yg2...";
TaskID = "3560";
ElementID = "2352";
Text = "New elements text";
Result = OPI_Bitrix24.UpdateTasksChecklistElement(URL, TaskID, ElementID, Text);
URL = "b24-ar17wx.bitrix24.by";
Token = "7afc3e67006e9f06006b12e400000001000...";
TaskID = "3562";
ElementID = "2356";
Result = OPI_Bitrix24.UpdateTasksChecklistElement(URL, TaskID, ElementID, Text, Token);
```
<Tabs>
<TabItem value="bash" label="Bash" default>
```bash
oint bitrix24 UpdateTasksChecklistElement \
--url "b24-ar17wx.bitrix24.by" \
--task "3592" \
--element 2380 \
--text "New elements text" \
--token "***"
```
</TabItem>
<TabItem value="bat" label="CMD/Bat" default>
```batch
oint bitrix24 UpdateTasksChecklistElement ^
--url "b24-ar17wx.bitrix24.by" ^
--task "3592" ^
--element 2380 ^
--text "New elements text" ^
--token "***"
```
</TabItem>
</Tabs>
```json title="Result"
{
"result": null,
"time": {
"start": 1728454786.34816,
"finish": 1728454786.41181,
"duration": 0.0636470317840576,
"processing": 0.0358831882476807,
"date_start": "2024-10-09T09:19:46+03:00",
"date_finish": "2024-10-09T09:19:46+03:00",
"operating_reset_at": 1728455386,
"operating": 0
}
}
```

View File

@@ -0,0 +1,4 @@
{
"label": "Tasks checklists management",
"position": "6"
}