mirror of
https://github.com/Bayselonarrend/OpenIntegrations.git
synced 2025-02-15 14:03:22 +02:00
Main build (Jenkins)
This commit is contained in:
Vitaly the Alpaca (bot)
parent
fa0496b90c
commit
272287087c
@ -1,53 +0,0 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Create comment
|
||||
Creates a comment for a record in the table
|
||||
|
||||
|
||||
|
||||
`Function CreateComment(Val Token, Val Base, Val Table, Val Record, Val Text) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Token | --token | String | Token |
|
||||
| Base | --base | String | Database identifier |
|
||||
| Table | --table | String | Table identifier |
|
||||
| Record | --record | String | Record identifier in the table |
|
||||
| Text | --text | String | Comment text |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON response from Airtable
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d...";
|
||||
Base = "appESy99HYCLbuWlV";
|
||||
Table = "tbl5gZLQ8i5xKuVTy";
|
||||
Record = "recHqUT4ruWn8KnYi";
|
||||
Text = "TestComment";
|
||||
|
||||
Result = OPI_Airtable.CreateComment(Token, Base, Table, Record, Text);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"id": "comwNg41PXtfEa4kj",
|
||||
"author": {
|
||||
"id": "usrFlaAHlTfYWAbVW",
|
||||
"email": "bayselonarrend@gmail.com",
|
||||
"name": "Антон Титовец"
|
||||
},
|
||||
"text": "TestComment",
|
||||
"createdTime": "2024-10-09T06:15:49.133Z",
|
||||
"lastUpdatedTime": null
|
||||
}
|
||||
```
|
||||
56
docs/en/md/Airtable/Comment-management/Create-comment.mdx
Normal file
56
docs/en/md/Airtable/Comment-management/Create-comment.mdx
Normal file
@ -0,0 +1,56 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Create comment
|
||||
Creates a comment for a record in the table
|
||||
|
||||
|
||||
|
||||
`Function CreateComment(Val Token, Val Base, Val Table, Val Record, Val Text) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Token | --token | String | Token |
|
||||
| Base | --base | String | Database identifier |
|
||||
| Table | --table | String | Table identifier |
|
||||
| Record | --record | String | Record identifier in the table |
|
||||
| Text | --text | String | Comment text |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON response from Airtable
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d...";
|
||||
Base = "appESy99HYCLbuWlV";
|
||||
Table = "tbl5gZLQ8i5xKuVTy";
|
||||
Record = "recHqUT4ruWn8KnYi";
|
||||
Text = "TestComment";
|
||||
|
||||
Result = OPI_Airtable.CreateComment(Token, Base, Table, Record, Text);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"id": "comwNg41PXtfEa4kj",
|
||||
"author": {
|
||||
"id": "usrFlaAHlTfYWAbVW",
|
||||
"email": "bayselonarrend@gmail.com",
|
||||
"name": "Антон Титовец"
|
||||
},
|
||||
"text": "TestComment",
|
||||
"createdTime": "2024-10-09T06:15:49.133Z",
|
||||
"lastUpdatedTime": null
|
||||
}
|
||||
```
|
||||
@ -1,46 +0,0 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
---
|
||||
|
||||
# Delete comment
|
||||
Deletes a comment for a table record
|
||||
|
||||
|
||||
|
||||
`Function DeleteComment(Val Token, Val Base, Val Table, Val Record, Val Comment) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Token | --token | String | Token |
|
||||
| Base | --base | String | Database identifier |
|
||||
| Table | --table | String | Table identifier |
|
||||
| Record | --record | String | Record identifier in the table |
|
||||
| Comment | --comment | String | Comment identifier |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON response from Airtable
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d...";
|
||||
Base = "appESy99HYCLbuWlV";
|
||||
Table = "tbl5gZLQ8i5xKuVTy";
|
||||
Record = "recHqUT4ruWn8KnYi";
|
||||
Comment = "comc3oQtvx4mn0pdu";
|
||||
|
||||
Result = OPI_Airtable.DeleteComment(Token, Base, Table, Record, Comment);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"id": "comwNg41PXtfEa4kj",
|
||||
"deleted": true
|
||||
}
|
||||
```
|
||||
49
docs/en/md/Airtable/Comment-management/Delete-comment.mdx
Normal file
49
docs/en/md/Airtable/Comment-management/Delete-comment.mdx
Normal file
@ -0,0 +1,49 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 4
|
||||
---
|
||||
|
||||
# Delete comment
|
||||
Deletes a comment for a table record
|
||||
|
||||
|
||||
|
||||
`Function DeleteComment(Val Token, Val Base, Val Table, Val Record, Val Comment) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Token | --token | String | Token |
|
||||
| Base | --base | String | Database identifier |
|
||||
| Table | --table | String | Table identifier |
|
||||
| Record | --record | String | Record identifier in the table |
|
||||
| Comment | --comment | String | Comment identifier |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON response from Airtable
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d...";
|
||||
Base = "appESy99HYCLbuWlV";
|
||||
Table = "tbl5gZLQ8i5xKuVTy";
|
||||
Record = "recHqUT4ruWn8KnYi";
|
||||
Comment = "comc3oQtvx4mn0pdu";
|
||||
|
||||
Result = OPI_Airtable.DeleteComment(Token, Base, Table, Record, Comment);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"id": "comwNg41PXtfEa4kj",
|
||||
"deleted": true
|
||||
}
|
||||
```
|
||||
@ -1,57 +0,0 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# Modify comment
|
||||
Changes the text of an existing comment
|
||||
|
||||
|
||||
|
||||
`Function EditComment(Val Token, Val Base, Val Table, Val Record, Val Comment, Val Text) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Token | --token | String | Token |
|
||||
| Base | --base | String | Database identifier |
|
||||
| Table | --table | String | Table identifier |
|
||||
| Record | --record | String | Record identifier in the table |
|
||||
| Comment | --comment | String | Comment identifier |
|
||||
| Text | --text | String | New comment text |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON response from Airtable
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d...";
|
||||
Base = "appESy99HYCLbuWlV";
|
||||
Table = "tbl5gZLQ8i5xKuVTy";
|
||||
Record = "recHqUT4ruWn8KnYi";
|
||||
Comment = "comc3oQtvx4mn0pdu";
|
||||
|
||||
Text = "Test comment (change.)";
|
||||
Result = OPI_Airtable.EditComment(Token, Base, Table, Record, Comment, Text);
|
||||
|
||||
OPI_TestDataRetrieval.Check_ATText(Result, Text);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"id": "comwNg41PXtfEa4kj",
|
||||
"author": {
|
||||
"id": "usrFlaAHlTfYWAbVW",
|
||||
"email": "bayselonarrend@gmail.com",
|
||||
"name": "Антон Титовец"
|
||||
},
|
||||
"text": "Test comment (change.)",
|
||||
"createdTime": "2024-10-09T06:15:49Z",
|
||||
"lastUpdatedTime": "2024-10-09T06:15:49.55Z"
|
||||
}
|
||||
```
|
||||
60
docs/en/md/Airtable/Comment-management/Edit-comment.mdx
Normal file
60
docs/en/md/Airtable/Comment-management/Edit-comment.mdx
Normal file
@ -0,0 +1,60 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# Modify comment
|
||||
Changes the text of an existing comment
|
||||
|
||||
|
||||
|
||||
`Function EditComment(Val Token, Val Base, Val Table, Val Record, Val Comment, Val Text) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Token | --token | String | Token |
|
||||
| Base | --base | String | Database identifier |
|
||||
| Table | --table | String | Table identifier |
|
||||
| Record | --record | String | Record identifier in the table |
|
||||
| Comment | --comment | String | Comment identifier |
|
||||
| Text | --text | String | New comment text |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON response from Airtable
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d...";
|
||||
Base = "appESy99HYCLbuWlV";
|
||||
Table = "tbl5gZLQ8i5xKuVTy";
|
||||
Record = "recHqUT4ruWn8KnYi";
|
||||
Comment = "comc3oQtvx4mn0pdu";
|
||||
|
||||
Text = "Test comment (change.)";
|
||||
Result = OPI_Airtable.EditComment(Token, Base, Table, Record, Comment, Text);
|
||||
|
||||
OPI_TestDataRetrieval.Check_ATText(Result, Text);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"id": "comwNg41PXtfEa4kj",
|
||||
"author": {
|
||||
"id": "usrFlaAHlTfYWAbVW",
|
||||
"email": "bayselonarrend@gmail.com",
|
||||
"name": "Антон Титовец"
|
||||
},
|
||||
"text": "Test comment (change.)",
|
||||
"createdTime": "2024-10-09T06:15:49Z",
|
||||
"lastUpdatedTime": "2024-10-09T06:15:49.55Z"
|
||||
}
|
||||
```
|
||||
@ -1,57 +0,0 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Get comments
|
||||
Gets the list of comments for a record in the table
|
||||
|
||||
|
||||
|
||||
`Function GetComments(Val Token, Val Base, Val Table, Val Record, Val Indent = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Token | --token | String | Token |
|
||||
| Base | --base | String | Database identifier |
|
||||
| Table | --table | String | Table identifier |
|
||||
| Record | --record | String | Record identifier in the table |
|
||||
| Indent | --offset | String | Next page identifier of data from the previous request |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON response from Airtable
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d...";
|
||||
Base = "appESy99HYCLbuWlV";
|
||||
Table = "tbl5gZLQ8i5xKuVTy";
|
||||
Record = "recHqUT4ruWn8KnYi";
|
||||
|
||||
Result = OPI_Airtable.GetComments(Token, Base, Table, Record);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"comments": [
|
||||
{
|
||||
"id": "comwNg41PXtfEa4kj",
|
||||
"author": {
|
||||
"id": "usrFlaAHlTfYWAbVW",
|
||||
"email": "bayselonarrend@gmail.com",
|
||||
"name": "Антон Титовец"
|
||||
},
|
||||
"text": "Test comment (change.)",
|
||||
"createdTime": "2024-10-09T06:15:49Z",
|
||||
"lastUpdatedTime": "2024-10-09T06:15:50Z"
|
||||
}
|
||||
],
|
||||
"offset": null
|
||||
}
|
||||
```
|
||||
60
docs/en/md/Airtable/Comment-management/Get-comments.mdx
Normal file
60
docs/en/md/Airtable/Comment-management/Get-comments.mdx
Normal file
@ -0,0 +1,60 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Get comments
|
||||
Gets the list of comments for a record in the table
|
||||
|
||||
|
||||
|
||||
`Function GetComments(Val Token, Val Base, Val Table, Val Record, Val Indent = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Token | --token | String | Token |
|
||||
| Base | --base | String | Database identifier |
|
||||
| Table | --table | String | Table identifier |
|
||||
| Record | --record | String | Record identifier in the table |
|
||||
| Indent | --offset | String | Next page identifier of data from the previous request |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON response from Airtable
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d...";
|
||||
Base = "appESy99HYCLbuWlV";
|
||||
Table = "tbl5gZLQ8i5xKuVTy";
|
||||
Record = "recHqUT4ruWn8KnYi";
|
||||
|
||||
Result = OPI_Airtable.GetComments(Token, Base, Table, Record);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"comments": [
|
||||
{
|
||||
"id": "comwNg41PXtfEa4kj",
|
||||
"author": {
|
||||
"id": "usrFlaAHlTfYWAbVW",
|
||||
"email": "bayselonarrend@gmail.com",
|
||||
"name": "Антон Титовец"
|
||||
},
|
||||
"text": "Test comment (change.)",
|
||||
"createdTime": "2024-10-09T06:15:49Z",
|
||||
"lastUpdatedTime": "2024-10-09T06:15:50Z"
|
||||
}
|
||||
],
|
||||
"offset": null
|
||||
}
|
||||
```
|
||||
@ -1,69 +0,0 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# Create records
|
||||
Creates one or an array of records by description or an array of field value descriptions
|
||||
|
||||
|
||||
|
||||
`Function CreatePosts(Val Token, Val Base, Val Table, Val Data) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Token | --token | String | Token |
|
||||
| Base | --base | String | Database identifier |
|
||||
| Table | --table | String | Table identifier |
|
||||
| Data | --data | Structure, Array of Structure | Set or array of sets of pairs Key : Value > Field : FieldValue |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON response from Airtable
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d...";
|
||||
Base = "appESy99HYCLbuWlV";
|
||||
Table = "tbl5gZLQ8i5xKuVTy";
|
||||
|
||||
Number = 10;
|
||||
String = "Hello";
|
||||
|
||||
RowDescription1 = New Structure("Number,String", Number, String);
|
||||
RowDescription2 = New Structure("Number,String", Number, String);
|
||||
|
||||
ArrayOfDescriptions = New Array;
|
||||
ArrayOfDescriptions.Add(RowDescription1);
|
||||
ArrayOfDescriptions.Add(RowDescription2);
|
||||
|
||||
Result = OPI_Airtable.CreatePosts(Token, Base, Table, ArrayOfDescriptions);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"records": [
|
||||
{
|
||||
"id": "recVZd6lgdfEkIH0o",
|
||||
"createdTime": "2024-10-09T06:15:48Z",
|
||||
"fields": {
|
||||
"Number": 10,
|
||||
"String": "Hello\n"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "recenScnS1yuI8Dsk",
|
||||
"createdTime": "2024-10-09T06:15:48Z",
|
||||
"fields": {
|
||||
"Number": 10,
|
||||
"String": "Hello\n"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
72
docs/en/md/Airtable/Record-management/Create-posts.mdx
Normal file
72
docs/en/md/Airtable/Record-management/Create-posts.mdx
Normal file
@ -0,0 +1,72 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# Create records
|
||||
Creates one or an array of records by description or an array of field value descriptions
|
||||
|
||||
|
||||
|
||||
`Function CreatePosts(Val Token, Val Base, Val Table, Val Data) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Token | --token | String | Token |
|
||||
| Base | --base | String | Database identifier |
|
||||
| Table | --table | String | Table identifier |
|
||||
| Data | --data | Structure, Array of Structure | Set or array of sets of pairs Key : Value > Field : FieldValue |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON response from Airtable
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d...";
|
||||
Base = "appESy99HYCLbuWlV";
|
||||
Table = "tbl5gZLQ8i5xKuVTy";
|
||||
|
||||
Number = 10;
|
||||
String = "Hello";
|
||||
|
||||
RowDescription1 = New Structure("Number,String", Number, String);
|
||||
RowDescription2 = New Structure("Number,String", Number, String);
|
||||
|
||||
ArrayOfDescriptions = New Array;
|
||||
ArrayOfDescriptions.Add(RowDescription1);
|
||||
ArrayOfDescriptions.Add(RowDescription2);
|
||||
|
||||
Result = OPI_Airtable.CreatePosts(Token, Base, Table, ArrayOfDescriptions);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"records": [
|
||||
{
|
||||
"id": "recVZd6lgdfEkIH0o",
|
||||
"createdTime": "2024-10-09T06:15:48Z",
|
||||
"fields": {
|
||||
"Number": 10,
|
||||
"String": "Hello\n"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "recenScnS1yuI8Dsk",
|
||||
"createdTime": "2024-10-09T06:15:48Z",
|
||||
"fields": {
|
||||
"Number": 10,
|
||||
"String": "Hello\n"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
@ -1,48 +0,0 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
---
|
||||
|
||||
# Delete records
|
||||
Deletes one or an array of records by identifiers
|
||||
|
||||
|
||||
|
||||
`Function DeletePosts(Val Token, Val Base, Val Table, Val Records) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Token | --token | String | Token |
|
||||
| Base | --base | String | Database identifier |
|
||||
| Table | --table | String | Table identifier |
|
||||
| Records | --records | String, Array of String | Identifier or array of record identifiers |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON response from Airtable
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d...";
|
||||
Base = "appESy99HYCLbuWlV";
|
||||
Table = "tbl5gZLQ8i5xKuVTy";
|
||||
Record = "recHqUT4ruWn8KnYi";
|
||||
|
||||
Result = OPI_Airtable.DeletePosts(Token, Base, Table, Record);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"records": [
|
||||
{
|
||||
"deleted": true,
|
||||
"id": "recMPMkPT6RzcSyqt"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
51
docs/en/md/Airtable/Record-management/Delete-posts.mdx
Normal file
51
docs/en/md/Airtable/Record-management/Delete-posts.mdx
Normal file
@ -0,0 +1,51 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 4
|
||||
---
|
||||
|
||||
# Delete records
|
||||
Deletes one or an array of records by identifiers
|
||||
|
||||
|
||||
|
||||
`Function DeletePosts(Val Token, Val Base, Val Table, Val Records) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Token | --token | String | Token |
|
||||
| Base | --base | String | Database identifier |
|
||||
| Table | --table | String | Table identifier |
|
||||
| Records | --records | String, Array of String | Identifier or array of record identifiers |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON response from Airtable
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d...";
|
||||
Base = "appESy99HYCLbuWlV";
|
||||
Table = "tbl5gZLQ8i5xKuVTy";
|
||||
Record = "recHqUT4ruWn8KnYi";
|
||||
|
||||
Result = OPI_Airtable.DeletePosts(Token, Base, Table, Record);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"records": [
|
||||
{
|
||||
"deleted": true,
|
||||
"id": "recMPMkPT6RzcSyqt"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
@ -1,51 +0,0 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Get list of records
|
||||
Gets the list of records of the selected table
|
||||
|
||||
|
||||
|
||||
`Function GetListOfRecords(Val Token, Val Base, Val Table, Val Indent = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Token | --token | String | Token |
|
||||
| Base | --base | String | Database identifier |
|
||||
| Table | --table | String | Table identifier |
|
||||
| Indent | --offset | String | Next page identifier of data from the previous request |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON response from Airtable
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d...";
|
||||
Base = "appESy99HYCLbuWlV";
|
||||
Table = "tbl5gZLQ8i5xKuVTy";
|
||||
|
||||
Result = OPI_Airtable.GetListOfRecords(Token, Base, Table);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"records": [
|
||||
{
|
||||
"id": "recMPMkPT6RzcSyqt",
|
||||
"createdTime": "2024-10-09T06:15:49Z",
|
||||
"fields": {
|
||||
"Number": 10,
|
||||
"String": "Hello\n"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
@ -0,0 +1,54 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Get list of records
|
||||
Gets the list of records of the selected table
|
||||
|
||||
|
||||
|
||||
`Function GetListOfRecords(Val Token, Val Base, Val Table, Val Indent = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Token | --token | String | Token |
|
||||
| Base | --base | String | Database identifier |
|
||||
| Table | --table | String | Table identifier |
|
||||
| Indent | --offset | String | Next page identifier of data from the previous request |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON response from Airtable
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d...";
|
||||
Base = "appESy99HYCLbuWlV";
|
||||
Table = "tbl5gZLQ8i5xKuVTy";
|
||||
|
||||
Result = OPI_Airtable.GetListOfRecords(Token, Base, Table);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"records": [
|
||||
{
|
||||
"id": "recMPMkPT6RzcSyqt",
|
||||
"createdTime": "2024-10-09T06:15:49Z",
|
||||
"fields": {
|
||||
"Number": 10,
|
||||
"String": "Hello\n"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
@ -1,48 +0,0 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Get record
|
||||
Gets row data of the table by identifier
|
||||
|
||||
|
||||
|
||||
`Function GetRecord(Val Token, Val Base, Val Table, Val Record) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Token | --token | String | Token |
|
||||
| Base | --base | String | Database identifier |
|
||||
| Table | --table | String | Table identifier |
|
||||
| Record | --record | String | Record identifier in the table |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON response from Airtable
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d...";
|
||||
Base = "appESy99HYCLbuWlV";
|
||||
Table = "tbl5gZLQ8i5xKuVTy";
|
||||
Record = "recHqUT4ruWn8KnYi";
|
||||
|
||||
Result = OPI_Airtable.GetRecord(Token, Base, Table, Record);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"id": "recMPMkPT6RzcSyqt",
|
||||
"createdTime": "2024-10-09T06:15:49Z",
|
||||
"fields": {
|
||||
"Number": 10,
|
||||
"String": "Hello\n"
|
||||
}
|
||||
}
|
||||
```
|
||||
51
docs/en/md/Airtable/Record-management/Get-record.mdx
Normal file
51
docs/en/md/Airtable/Record-management/Get-record.mdx
Normal file
@ -0,0 +1,51 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Get record
|
||||
Gets row data of the table by identifier
|
||||
|
||||
|
||||
|
||||
`Function GetRecord(Val Token, Val Base, Val Table, Val Record) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Token | --token | String | Token |
|
||||
| Base | --base | String | Database identifier |
|
||||
| Table | --table | String | Table identifier |
|
||||
| Record | --record | String | Record identifier in the table |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON response from Airtable
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d...";
|
||||
Base = "appESy99HYCLbuWlV";
|
||||
Table = "tbl5gZLQ8i5xKuVTy";
|
||||
Record = "recHqUT4ruWn8KnYi";
|
||||
|
||||
Result = OPI_Airtable.GetRecord(Token, Base, Table, Record);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"id": "recMPMkPT6RzcSyqt",
|
||||
"createdTime": "2024-10-09T06:15:49Z",
|
||||
"fields": {
|
||||
"Number": 10,
|
||||
"String": "Hello\n"
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -1,123 +0,0 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Create table
|
||||
Creates a new table in the base
|
||||
|
||||
|
||||
|
||||
`Function CreateTable(Val Token, Val Base, Val Name, Val FieldArray, Val Description = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Token | --token | String | Token |
|
||||
| Base | --base | String | Base identifier |
|
||||
| Name | --title | String | New table name |
|
||||
| FieldArray | --fieldsdata | Array of Structure | Array of field descriptions |
|
||||
| Description | --description | String | Table description |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON response from Airtable
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d...";
|
||||
Base = "appESy99HYCLbuWlV";
|
||||
|
||||
FieldArray = New Array;
|
||||
FieldArray.Add(OPI_Airtable.GetNumberField("Number"));
|
||||
FieldArray.Add(OPI_Airtable.GetStringField("String"));
|
||||
FieldArray.Add(OPI_Airtable.GetAttachmentField("Attachment"));
|
||||
FieldArray.Add(OPI_Airtable.GetCheckboxField("Checkbox"));
|
||||
FieldArray.Add(OPI_Airtable.GetDateField("Date"));
|
||||
FieldArray.Add(OPI_Airtable.GetPhoneField("Phone"));
|
||||
FieldArray.Add(OPI_Airtable.GetEmailField("Email"));
|
||||
FieldArray.Add(OPI_Airtable.GetLinkField("Link"));
|
||||
|
||||
Name = "TestTable2";
|
||||
Description = "NewTable";
|
||||
|
||||
Result = OPI_Airtable.CreateTable(Token, Base, Name, FieldArray, Description);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"id": "tbl1ECxOLd4V6OM9T",
|
||||
"name": "TestTable2",
|
||||
"description": "NewTable",
|
||||
"primaryFieldId": "fldhWwOjg9UhvJ6A2",
|
||||
"fields": [
|
||||
{
|
||||
"type": "number",
|
||||
"options": {
|
||||
"precision": 0
|
||||
},
|
||||
"id": "fldhWwOjg9UhvJ6A2",
|
||||
"name": "Number"
|
||||
},
|
||||
{
|
||||
"type": "richText",
|
||||
"id": "fld8KaCe62SjwSYAk",
|
||||
"name": "String"
|
||||
},
|
||||
{
|
||||
"type": "multipleAttachments",
|
||||
"options": {
|
||||
"isReversed": false
|
||||
},
|
||||
"id": "fldSWB4hUUyP5Hx30",
|
||||
"name": "Attachment"
|
||||
},
|
||||
{
|
||||
"type": "checkbox",
|
||||
"options": {
|
||||
"icon": "check",
|
||||
"color": "yellowBright"
|
||||
},
|
||||
"id": "fld7UipYF2w9FsoRm",
|
||||
"name": "Checkbox"
|
||||
},
|
||||
{
|
||||
"type": "date",
|
||||
"options": {
|
||||
"dateFormat": {
|
||||
"name": "iso",
|
||||
"format": "YYYY-MM-DD"
|
||||
}
|
||||
},
|
||||
"id": "fldHVbDsv6ndNp2XZ",
|
||||
"name": "Date"
|
||||
},
|
||||
{
|
||||
"type": "phoneNumber",
|
||||
"id": "fldYL0IFRMVQCO7gW",
|
||||
"name": "Phone"
|
||||
},
|
||||
{
|
||||
"type": "email",
|
||||
"id": "fldzsmOGCGjThDsUp",
|
||||
"name": "Email"
|
||||
},
|
||||
{
|
||||
"type": "url",
|
||||
"id": "fldMWVcVuR9CmKBcD",
|
||||
"name": "Link"
|
||||
}
|
||||
],
|
||||
"views": [
|
||||
{
|
||||
"id": "viwMlZ7T3KyjEufmW",
|
||||
"name": "Grid view",
|
||||
"type": "grid"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
126
docs/en/md/Airtable/Table-management/Create-table.mdx
Normal file
126
docs/en/md/Airtable/Table-management/Create-table.mdx
Normal file
@ -0,0 +1,126 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Create table
|
||||
Creates a new table in the base
|
||||
|
||||
|
||||
|
||||
`Function CreateTable(Val Token, Val Base, Val Name, Val FieldArray, Val Description = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Token | --token | String | Token |
|
||||
| Base | --base | String | Base identifier |
|
||||
| Name | --title | String | New table name |
|
||||
| FieldArray | --fieldsdata | Array of Structure | Array of field descriptions |
|
||||
| Description | --description | String | Table description |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON response from Airtable
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d...";
|
||||
Base = "appESy99HYCLbuWlV";
|
||||
|
||||
FieldArray = New Array;
|
||||
FieldArray.Add(OPI_Airtable.GetNumberField("Number"));
|
||||
FieldArray.Add(OPI_Airtable.GetStringField("String"));
|
||||
FieldArray.Add(OPI_Airtable.GetAttachmentField("Attachment"));
|
||||
FieldArray.Add(OPI_Airtable.GetCheckboxField("Checkbox"));
|
||||
FieldArray.Add(OPI_Airtable.GetDateField("Date"));
|
||||
FieldArray.Add(OPI_Airtable.GetPhoneField("Phone"));
|
||||
FieldArray.Add(OPI_Airtable.GetEmailField("Email"));
|
||||
FieldArray.Add(OPI_Airtable.GetLinkField("Link"));
|
||||
|
||||
Name = "TestTable2";
|
||||
Description = "NewTable";
|
||||
|
||||
Result = OPI_Airtable.CreateTable(Token, Base, Name, FieldArray, Description);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"id": "tbl1ECxOLd4V6OM9T",
|
||||
"name": "TestTable2",
|
||||
"description": "NewTable",
|
||||
"primaryFieldId": "fldhWwOjg9UhvJ6A2",
|
||||
"fields": [
|
||||
{
|
||||
"type": "number",
|
||||
"options": {
|
||||
"precision": 0
|
||||
},
|
||||
"id": "fldhWwOjg9UhvJ6A2",
|
||||
"name": "Number"
|
||||
},
|
||||
{
|
||||
"type": "richText",
|
||||
"id": "fld8KaCe62SjwSYAk",
|
||||
"name": "String"
|
||||
},
|
||||
{
|
||||
"type": "multipleAttachments",
|
||||
"options": {
|
||||
"isReversed": false
|
||||
},
|
||||
"id": "fldSWB4hUUyP5Hx30",
|
||||
"name": "Attachment"
|
||||
},
|
||||
{
|
||||
"type": "checkbox",
|
||||
"options": {
|
||||
"icon": "check",
|
||||
"color": "yellowBright"
|
||||
},
|
||||
"id": "fld7UipYF2w9FsoRm",
|
||||
"name": "Checkbox"
|
||||
},
|
||||
{
|
||||
"type": "date",
|
||||
"options": {
|
||||
"dateFormat": {
|
||||
"name": "iso",
|
||||
"format": "YYYY-MM-DD"
|
||||
}
|
||||
},
|
||||
"id": "fldHVbDsv6ndNp2XZ",
|
||||
"name": "Date"
|
||||
},
|
||||
{
|
||||
"type": "phoneNumber",
|
||||
"id": "fldYL0IFRMVQCO7gW",
|
||||
"name": "Phone"
|
||||
},
|
||||
{
|
||||
"type": "email",
|
||||
"id": "fldzsmOGCGjThDsUp",
|
||||
"name": "Email"
|
||||
},
|
||||
{
|
||||
"type": "url",
|
||||
"id": "fldMWVcVuR9CmKBcD",
|
||||
"name": "Link"
|
||||
}
|
||||
],
|
||||
"views": [
|
||||
{
|
||||
"id": "viwMlZ7T3KyjEufmW",
|
||||
"name": "Grid view",
|
||||
"type": "grid"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
@ -1,113 +0,0 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Modify table
|
||||
Changes the name and/or description of the base
|
||||
|
||||
|
||||
|
||||
`Function ModifyTable(Val Token, Val Base, Val Table, Val Name = "", Val Description = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Token | --token | String | Token |
|
||||
| Base | --base | String | Base identifier |
|
||||
| Table | --table | String | Table identifier |
|
||||
| Name | --title | String | New name |
|
||||
| Description | --description | String | New description |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON response from Airtable
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d...";
|
||||
Base = "appESy99HYCLbuWlV";
|
||||
Table = "tbl5gZLQ8i5xKuVTy";
|
||||
Name = "Test table 2 (change.)";
|
||||
Description = "New table (change.)";
|
||||
|
||||
Result = OPI_Airtable.ModifyTable(Token, Base, Table, Name, Description);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"id": "tbl1ECxOLd4V6OM9T",
|
||||
"name": "Test table 2 (change.)",
|
||||
"description": "New table (change.)",
|
||||
"primaryFieldId": "fldhWwOjg9UhvJ6A2",
|
||||
"fields": [
|
||||
{
|
||||
"id": "fldhWwOjg9UhvJ6A2",
|
||||
"name": "Number",
|
||||
"type": "number",
|
||||
"options": {
|
||||
"precision": 0
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "fld8KaCe62SjwSYAk",
|
||||
"name": "String",
|
||||
"type": "richText"
|
||||
},
|
||||
{
|
||||
"id": "fldSWB4hUUyP5Hx30",
|
||||
"name": "Attachment",
|
||||
"type": "multipleAttachments",
|
||||
"options": {
|
||||
"isReversed": false
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "fld7UipYF2w9FsoRm",
|
||||
"name": "Checkbox",
|
||||
"type": "checkbox",
|
||||
"options": {
|
||||
"icon": "check",
|
||||
"color": "yellowBright"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "fldHVbDsv6ndNp2XZ",
|
||||
"name": "Date",
|
||||
"type": "date",
|
||||
"options": {
|
||||
"dateFormat": {
|
||||
"name": "iso",
|
||||
"format": "YYYY-MM-DD"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "fldYL0IFRMVQCO7gW",
|
||||
"name": "Phone",
|
||||
"type": "phoneNumber"
|
||||
},
|
||||
{
|
||||
"id": "fldzsmOGCGjThDsUp",
|
||||
"name": "Email",
|
||||
"type": "email"
|
||||
},
|
||||
{
|
||||
"id": "fldMWVcVuR9CmKBcD",
|
||||
"name": "Link",
|
||||
"type": "url"
|
||||
}
|
||||
],
|
||||
"views": [
|
||||
{
|
||||
"id": "viwMlZ7T3KyjEufmW",
|
||||
"name": "Grid view",
|
||||
"type": "grid"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
116
docs/en/md/Airtable/Table-management/Modify-table.mdx
Normal file
116
docs/en/md/Airtable/Table-management/Modify-table.mdx
Normal file
@ -0,0 +1,116 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Modify table
|
||||
Changes the name and/or description of the base
|
||||
|
||||
|
||||
|
||||
`Function ModifyTable(Val Token, Val Base, Val Table, Val Name = "", Val Description = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Token | --token | String | Token |
|
||||
| Base | --base | String | Base identifier |
|
||||
| Table | --table | String | Table identifier |
|
||||
| Name | --title | String | New name |
|
||||
| Description | --description | String | New description |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON response from Airtable
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d...";
|
||||
Base = "appESy99HYCLbuWlV";
|
||||
Table = "tbl5gZLQ8i5xKuVTy";
|
||||
Name = "Test table 2 (change.)";
|
||||
Description = "New table (change.)";
|
||||
|
||||
Result = OPI_Airtable.ModifyTable(Token, Base, Table, Name, Description);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"id": "tbl1ECxOLd4V6OM9T",
|
||||
"name": "Test table 2 (change.)",
|
||||
"description": "New table (change.)",
|
||||
"primaryFieldId": "fldhWwOjg9UhvJ6A2",
|
||||
"fields": [
|
||||
{
|
||||
"id": "fldhWwOjg9UhvJ6A2",
|
||||
"name": "Number",
|
||||
"type": "number",
|
||||
"options": {
|
||||
"precision": 0
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "fld8KaCe62SjwSYAk",
|
||||
"name": "String",
|
||||
"type": "richText"
|
||||
},
|
||||
{
|
||||
"id": "fldSWB4hUUyP5Hx30",
|
||||
"name": "Attachment",
|
||||
"type": "multipleAttachments",
|
||||
"options": {
|
||||
"isReversed": false
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "fld7UipYF2w9FsoRm",
|
||||
"name": "Checkbox",
|
||||
"type": "checkbox",
|
||||
"options": {
|
||||
"icon": "check",
|
||||
"color": "yellowBright"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "fldHVbDsv6ndNp2XZ",
|
||||
"name": "Date",
|
||||
"type": "date",
|
||||
"options": {
|
||||
"dateFormat": {
|
||||
"name": "iso",
|
||||
"format": "YYYY-MM-DD"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "fldYL0IFRMVQCO7gW",
|
||||
"name": "Phone",
|
||||
"type": "phoneNumber"
|
||||
},
|
||||
{
|
||||
"id": "fldzsmOGCGjThDsUp",
|
||||
"name": "Email",
|
||||
"type": "email"
|
||||
},
|
||||
{
|
||||
"id": "fldMWVcVuR9CmKBcD",
|
||||
"name": "Link",
|
||||
"type": "url"
|
||||
}
|
||||
],
|
||||
"views": [
|
||||
{
|
||||
"id": "viwMlZ7T3KyjEufmW",
|
||||
"name": "Grid view",
|
||||
"type": "grid"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
@ -1,80 +0,0 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# Create base
|
||||
Creates a new database
|
||||
|
||||
|
||||
|
||||
`Function CreateDatabase(Val Token, Val Workspace, Val Name, Val TableCollection) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Token | --token | String | Token |
|
||||
| Workspace | --ws | String | Workspace identifier |
|
||||
| Name | --title | String | New base name |
|
||||
| TableCollection | --tablesdata | Map Of KeyAndValue | Table description: Key > name, Value > array of fields |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON response from Airtable
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d...";
|
||||
Region = "wspdf8yl1yZz3PmWZ";
|
||||
Name = "TestDatabase";
|
||||
|
||||
FieldArray = New Array;
|
||||
FieldArray.Add(OPI_Airtable.GetNumberField("Number"));
|
||||
FieldArray.Add(OPI_Airtable.GetStringField("String"));
|
||||
|
||||
TableName = "TestTable";
|
||||
|
||||
TableMapping = New Map;
|
||||
TableMapping.Insert(TableName, FieldArray);
|
||||
|
||||
Result = OPI_Airtable.CreateDatabase(Token, Region, Name, TableMapping);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"id": "appD2vawGftoNUTKW",
|
||||
"tables": [
|
||||
{
|
||||
"id": "tblbhqzh3PL3cS6Ch",
|
||||
"name": "TestTable",
|
||||
"primaryFieldId": "fld9JrMjoVLwSPy3C",
|
||||
"fields": [
|
||||
{
|
||||
"type": "number",
|
||||
"options": {
|
||||
"precision": 0
|
||||
},
|
||||
"id": "fld9JrMjoVLwSPy3C",
|
||||
"name": "Number"
|
||||
},
|
||||
{
|
||||
"type": "richText",
|
||||
"id": "fld044xLas7uBdddr",
|
||||
"name": "String"
|
||||
}
|
||||
],
|
||||
"views": [
|
||||
{
|
||||
"id": "viwfJdwEI0dtqJMl6",
|
||||
"name": "Grid view",
|
||||
"type": "grid"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
@ -0,0 +1,83 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# Create base
|
||||
Creates a new database
|
||||
|
||||
|
||||
|
||||
`Function CreateDatabase(Val Token, Val Workspace, Val Name, Val TableCollection) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Token | --token | String | Token |
|
||||
| Workspace | --ws | String | Workspace identifier |
|
||||
| Name | --title | String | New base name |
|
||||
| TableCollection | --tablesdata | Map Of KeyAndValue | Table description: Key > name, Value > array of fields |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON response from Airtable
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d...";
|
||||
Region = "wspdf8yl1yZz3PmWZ";
|
||||
Name = "TestDatabase";
|
||||
|
||||
FieldArray = New Array;
|
||||
FieldArray.Add(OPI_Airtable.GetNumberField("Number"));
|
||||
FieldArray.Add(OPI_Airtable.GetStringField("String"));
|
||||
|
||||
TableName = "TestTable";
|
||||
|
||||
TableMapping = New Map;
|
||||
TableMapping.Insert(TableName, FieldArray);
|
||||
|
||||
Result = OPI_Airtable.CreateDatabase(Token, Region, Name, TableMapping);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"id": "appD2vawGftoNUTKW",
|
||||
"tables": [
|
||||
{
|
||||
"id": "tblbhqzh3PL3cS6Ch",
|
||||
"name": "TestTable",
|
||||
"primaryFieldId": "fld9JrMjoVLwSPy3C",
|
||||
"fields": [
|
||||
{
|
||||
"type": "number",
|
||||
"options": {
|
||||
"precision": 0
|
||||
},
|
||||
"id": "fld9JrMjoVLwSPy3C",
|
||||
"name": "Number"
|
||||
},
|
||||
{
|
||||
"type": "richText",
|
||||
"id": "fld044xLas7uBdddr",
|
||||
"name": "String"
|
||||
}
|
||||
],
|
||||
"views": [
|
||||
{
|
||||
"id": "viwfJdwEI0dtqJMl6",
|
||||
"name": "Grid view",
|
||||
"type": "grid"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
@ -1,67 +0,0 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Get base tables
|
||||
Gets the schema of base tables
|
||||
|
||||
|
||||
|
||||
`Function GetDatabaseTables(Val Token, Val Base) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Token | --token | String | Token |
|
||||
| Base | --base | String | Base identifier |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON response from Airtable
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d...";
|
||||
Base = "appESy99HYCLbuWlV";
|
||||
|
||||
Result = OPI_Airtable.GetDatabaseTables(Token, Base);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"tables": [
|
||||
{
|
||||
"id": "tblbhqzh3PL3cS6Ch",
|
||||
"name": "TestTable",
|
||||
"primaryFieldId": "fld9JrMjoVLwSPy3C",
|
||||
"fields": [
|
||||
{
|
||||
"type": "number",
|
||||
"options": {
|
||||
"precision": 0
|
||||
},
|
||||
"id": "fld9JrMjoVLwSPy3C",
|
||||
"name": "Number"
|
||||
},
|
||||
{
|
||||
"type": "richText",
|
||||
"id": "fld044xLas7uBdddr",
|
||||
"name": "String"
|
||||
}
|
||||
],
|
||||
"views": [
|
||||
{
|
||||
"id": "viwfJdwEI0dtqJMl6",
|
||||
"name": "Grid view",
|
||||
"type": "grid"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
@ -0,0 +1,70 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Get base tables
|
||||
Gets the schema of base tables
|
||||
|
||||
|
||||
|
||||
`Function GetDatabaseTables(Val Token, Val Base) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Token | --token | String | Token |
|
||||
| Base | --base | String | Base identifier |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON response from Airtable
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d...";
|
||||
Base = "appESy99HYCLbuWlV";
|
||||
|
||||
Result = OPI_Airtable.GetDatabaseTables(Token, Base);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"tables": [
|
||||
{
|
||||
"id": "tblbhqzh3PL3cS6Ch",
|
||||
"name": "TestTable",
|
||||
"primaryFieldId": "fld9JrMjoVLwSPy3C",
|
||||
"fields": [
|
||||
{
|
||||
"type": "number",
|
||||
"options": {
|
||||
"precision": 0
|
||||
},
|
||||
"id": "fld9JrMjoVLwSPy3C",
|
||||
"name": "Number"
|
||||
},
|
||||
{
|
||||
"type": "richText",
|
||||
"id": "fld044xLas7uBdddr",
|
||||
"name": "String"
|
||||
}
|
||||
],
|
||||
"views": [
|
||||
{
|
||||
"id": "viwfJdwEI0dtqJMl6",
|
||||
"name": "Grid view",
|
||||
"type": "grid"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
@ -1,186 +0,0 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Get list of bases
|
||||
Gets the list of available bases
|
||||
|
||||
|
||||
|
||||
`Function GetListOfBases(Val Token, Val Indent = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Token | --token | String | Token |
|
||||
| Indent | --offset | String | Next page identifier of the base list from the previous request |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON response from Airtable
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d...";
|
||||
|
||||
Result = OPI_Airtable.GetListOfBases(Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"bases": [
|
||||
{
|
||||
"id": "appGarzKZ0lu3gzoa",
|
||||
"name": "Test",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "app9WRfJirwn3yXuG",
|
||||
"name": "Product catalog",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "app6gigUYTzlDEq4X",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "app5hJGyK8asYYe1Q",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "appRQ6VxxOZb40Uwi",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "appM6FaGofV2XSfFA",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "apptm8Xqo7TwMaipQ",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "appsyQyGrF8aVN2Wm",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "applEsyJmBRm12AuN",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "appbh1wYGbZlmn3pN",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "apppkKYsw7O1Gqhxl",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "appIHzEhKAimg9S2p",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "app5Zyj15QZisbqvA",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "app05ybJZ2aiF7jiV",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "appKbK1rnu08kOueO",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "appBTTgSQtzCkrp4V",
|
||||
"name": "База из Оинт",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "appDtM9dK5yzXduUB",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "appqyGu9Cdx9xWvEs",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "appczCGkB55A13rQ2",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "appxClK6G6i2DREOB",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "appsYySkvo8kafUdd",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "appw2EFeyyNgwmhP6",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "appqEloLDyI7p6uzS",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "appdTFa0GMiOdaxVp",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "appuREJLUMSxU9Tww",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "appQwerTglYZLYkLl",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "apptPCnUGDn0M76to",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "appgg50vNZwX1aZmu",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "appHB3hm34ZkAjflT",
|
||||
"name": "TestDatabase",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "appuHDfwXADAD5QDj",
|
||||
"name": "TestDatabase",
|
||||
...
|
||||
```
|
||||
189
docs/en/md/Airtable/Working-with-databases/Get-list-of-bases.mdx
Normal file
189
docs/en/md/Airtable/Working-with-databases/Get-list-of-bases.mdx
Normal file
@ -0,0 +1,189 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Get list of bases
|
||||
Gets the list of available bases
|
||||
|
||||
|
||||
|
||||
`Function GetListOfBases(Val Token, Val Indent = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Token | --token | String | Token |
|
||||
| Indent | --offset | String | Next page identifier of the base list from the previous request |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON response from Airtable
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d...";
|
||||
|
||||
Result = OPI_Airtable.GetListOfBases(Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"bases": [
|
||||
{
|
||||
"id": "appGarzKZ0lu3gzoa",
|
||||
"name": "Test",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "app9WRfJirwn3yXuG",
|
||||
"name": "Product catalog",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "app6gigUYTzlDEq4X",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "app5hJGyK8asYYe1Q",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "appRQ6VxxOZb40Uwi",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "appM6FaGofV2XSfFA",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "apptm8Xqo7TwMaipQ",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "appsyQyGrF8aVN2Wm",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "applEsyJmBRm12AuN",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "appbh1wYGbZlmn3pN",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "apppkKYsw7O1Gqhxl",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "appIHzEhKAimg9S2p",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "app5Zyj15QZisbqvA",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "app05ybJZ2aiF7jiV",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "appKbK1rnu08kOueO",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "appBTTgSQtzCkrp4V",
|
||||
"name": "База из Оинт",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "appDtM9dK5yzXduUB",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "appqyGu9Cdx9xWvEs",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "appczCGkB55A13rQ2",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "appxClK6G6i2DREOB",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "appsYySkvo8kafUdd",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "appw2EFeyyNgwmhP6",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "appqEloLDyI7p6uzS",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "appdTFa0GMiOdaxVp",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "appuREJLUMSxU9Tww",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "appQwerTglYZLYkLl",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "apptPCnUGDn0M76to",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "appgg50vNZwX1aZmu",
|
||||
"name": "Тестовая база",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "appHB3hm34ZkAjflT",
|
||||
"name": "TestDatabase",
|
||||
"permissionLevel": "create"
|
||||
},
|
||||
{
|
||||
"id": "appuHDfwXADAD5QDj",
|
||||
"name": "TestDatabase",
|
||||
...
|
||||
```
|
||||
@ -1,49 +0,0 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Create field
|
||||
Creates a new field in the table
|
||||
|
||||
|
||||
|
||||
`Function CreateField(Val Token, Val Base, Val Table, Val FieldStructure) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Token | --token | String | Token |
|
||||
| Base | --base | String | Base identifier |
|
||||
| Table | --table | String | Table identifier |
|
||||
| FieldStructure | --fielddata | Structure of KeyAndValue | Description of the new field |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON response from Airtable
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d...";
|
||||
Base = "appESy99HYCLbuWlV";
|
||||
Table = "tbl5gZLQ8i5xKuVTy";
|
||||
Name = String(New UUID);
|
||||
|
||||
Field = OPI_Airtable.GetNumberField(Name);
|
||||
Result = OPI_Airtable.CreateField(Token, Base, Table, Field);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"type": "number",
|
||||
"options": {
|
||||
"precision": 0
|
||||
},
|
||||
"id": "fldDqI1OXajeQw5Gg",
|
||||
"name": "b3fd1280-83b2-4145-838d-3437b14adee3"
|
||||
}
|
||||
```
|
||||
52
docs/en/md/Airtable/Working-with-fields/Create-field.mdx
Normal file
52
docs/en/md/Airtable/Working-with-fields/Create-field.mdx
Normal file
@ -0,0 +1,52 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Create field
|
||||
Creates a new field in the table
|
||||
|
||||
|
||||
|
||||
`Function CreateField(Val Token, Val Base, Val Table, Val FieldStructure) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Token | --token | String | Token |
|
||||
| Base | --base | String | Base identifier |
|
||||
| Table | --table | String | Table identifier |
|
||||
| FieldStructure | --fielddata | Structure of KeyAndValue | Description of the new field |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON response from Airtable
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d...";
|
||||
Base = "appESy99HYCLbuWlV";
|
||||
Table = "tbl5gZLQ8i5xKuVTy";
|
||||
Name = String(New UUID);
|
||||
|
||||
Field = OPI_Airtable.GetNumberField(Name);
|
||||
Result = OPI_Airtable.CreateField(Token, Base, Table, Field);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"type": "number",
|
||||
"options": {
|
||||
"precision": 0
|
||||
},
|
||||
"id": "fldDqI1OXajeQw5Gg",
|
||||
"name": "b3fd1280-83b2-4145-838d-3437b14adee3"
|
||||
}
|
||||
```
|
||||
@ -1,36 +0,0 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
---
|
||||
|
||||
# Get field (file)
|
||||
Gets the description of a file field
|
||||
|
||||
|
||||
|
||||
`Function GetAttachmentField(Val Name) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Name | --title | String | Field name |
|
||||
|
||||
|
||||
Returns: Structure - Field description
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Result = OPI_Airtable.GetAttachmentField("Attachment");
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"name": "Attachment",
|
||||
"type": "multipleAttachments"
|
||||
}
|
||||
```
|
||||
@ -0,0 +1,39 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 5
|
||||
---
|
||||
|
||||
# Get field (file)
|
||||
Gets the description of a file field
|
||||
|
||||
|
||||
|
||||
`Function GetAttachmentField(Val Name) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Name | --title | String | Field name |
|
||||
|
||||
|
||||
Returns: Structure - Field description
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Result = OPI_Airtable.GetAttachmentField("Attachment");
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"name": "Attachment",
|
||||
"type": "multipleAttachments"
|
||||
}
|
||||
```
|
||||
@ -1,40 +0,0 @@
|
||||
---
|
||||
sidebar_position: 6
|
||||
---
|
||||
|
||||
# Get field (checkbox)
|
||||
Gets the description of a boolean field
|
||||
|
||||
|
||||
|
||||
`Function GetCheckboxField(Val Name) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Name | --title | String | Field name |
|
||||
|
||||
|
||||
Returns: Structure - Field description
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Result = OPI_Airtable.GetCheckboxField("Checkbox");
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"name": "Checkbox",
|
||||
"type": "checkbox",
|
||||
"options": {
|
||||
"icon": "check",
|
||||
"color": "yellowBright"
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -0,0 +1,43 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 6
|
||||
---
|
||||
|
||||
# Get field (checkbox)
|
||||
Gets the description of a boolean field
|
||||
|
||||
|
||||
|
||||
`Function GetCheckboxField(Val Name) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Name | --title | String | Field name |
|
||||
|
||||
|
||||
Returns: Structure - Field description
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Result = OPI_Airtable.GetCheckboxField("Checkbox");
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"name": "Checkbox",
|
||||
"type": "checkbox",
|
||||
"options": {
|
||||
"icon": "check",
|
||||
"color": "yellowBright"
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -1,42 +0,0 @@
|
||||
---
|
||||
sidebar_position: 7
|
||||
---
|
||||
|
||||
# Get field (date)
|
||||
Gets the description of a date field
|
||||
|
||||
|
||||
|
||||
`Function GetDateField(Val Name) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Name | --title | String | Field name |
|
||||
|
||||
|
||||
Returns: Structure - Field description
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Result = OPI_Airtable.GetDateField("Date");
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"name": "Date",
|
||||
"type": "date",
|
||||
"options": {
|
||||
"dateFormat": {
|
||||
"format": "YYYY-MM-DD",
|
||||
"name": "iso"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
45
docs/en/md/Airtable/Working-with-fields/Get-date-field.mdx
Normal file
45
docs/en/md/Airtable/Working-with-fields/Get-date-field.mdx
Normal file
@ -0,0 +1,45 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 7
|
||||
---
|
||||
|
||||
# Get field (date)
|
||||
Gets the description of a date field
|
||||
|
||||
|
||||
|
||||
`Function GetDateField(Val Name) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Name | --title | String | Field name |
|
||||
|
||||
|
||||
Returns: Structure - Field description
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Result = OPI_Airtable.GetDateField("Date");
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"name": "Date",
|
||||
"type": "date",
|
||||
"options": {
|
||||
"dateFormat": {
|
||||
"format": "YYYY-MM-DD",
|
||||
"name": "iso"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -1,36 +0,0 @@
|
||||
---
|
||||
sidebar_position: 8
|
||||
---
|
||||
|
||||
# Get field (email)
|
||||
Gets the description of an email field
|
||||
|
||||
|
||||
|
||||
`Function GetEmailField(Val Name) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Name | --title | String | Field name |
|
||||
|
||||
|
||||
Returns: Structure - Field description
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Result = OPI_Airtable.GetEmailField("Email");
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"name": "Email",
|
||||
"type": "email"
|
||||
}
|
||||
```
|
||||
39
docs/en/md/Airtable/Working-with-fields/Get-email-field.mdx
Normal file
39
docs/en/md/Airtable/Working-with-fields/Get-email-field.mdx
Normal file
@ -0,0 +1,39 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 8
|
||||
---
|
||||
|
||||
# Get field (email)
|
||||
Gets the description of an email field
|
||||
|
||||
|
||||
|
||||
`Function GetEmailField(Val Name) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Name | --title | String | Field name |
|
||||
|
||||
|
||||
Returns: Structure - Field description
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Result = OPI_Airtable.GetEmailField("Email");
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"name": "Email",
|
||||
"type": "email"
|
||||
}
|
||||
```
|
||||
@ -1,36 +0,0 @@
|
||||
---
|
||||
sidebar_position: 10
|
||||
---
|
||||
|
||||
# Get field (url)
|
||||
Gets the description of a URL field
|
||||
|
||||
|
||||
|
||||
`Function GetLinkField(Val Name) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Name | --title | String | Field name |
|
||||
|
||||
|
||||
Returns: Structure - Field description
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Result = OPI_Airtable.GetLinkField("Link");
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"name": "Link",
|
||||
"type": "url"
|
||||
}
|
||||
```
|
||||
39
docs/en/md/Airtable/Working-with-fields/Get-link-field.mdx
Normal file
39
docs/en/md/Airtable/Working-with-fields/Get-link-field.mdx
Normal file
@ -0,0 +1,39 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 10
|
||||
---
|
||||
|
||||
# Get field (url)
|
||||
Gets the description of a URL field
|
||||
|
||||
|
||||
|
||||
`Function GetLinkField(Val Name) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Name | --title | String | Field name |
|
||||
|
||||
|
||||
Returns: Structure - Field description
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Result = OPI_Airtable.GetLinkField("Link");
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"name": "Link",
|
||||
"type": "url"
|
||||
}
|
||||
```
|
||||
@ -1,40 +0,0 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
---
|
||||
|
||||
# Get field (numeric)
|
||||
Gets the description of a numeric field
|
||||
|
||||
|
||||
|
||||
`Function GetNumberField(Val Name, Val Precision = 0) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Name | --title | String | New field name |
|
||||
| Precision | --precision | Number, String | Number of decimal places |
|
||||
|
||||
|
||||
Returns: Structure - Field description
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Result = OPI_Airtable.GetNumberField("Number");
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"name": "Number",
|
||||
"type": "number",
|
||||
"options": {
|
||||
"precision": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
43
docs/en/md/Airtable/Working-with-fields/Get-number-field.mdx
Normal file
43
docs/en/md/Airtable/Working-with-fields/Get-number-field.mdx
Normal file
@ -0,0 +1,43 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 4
|
||||
---
|
||||
|
||||
# Get field (numeric)
|
||||
Gets the description of a numeric field
|
||||
|
||||
|
||||
|
||||
`Function GetNumberField(Val Name, Val Precision = 0) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Name | --title | String | New field name |
|
||||
| Precision | --precision | Number, String | Number of decimal places |
|
||||
|
||||
|
||||
Returns: Structure - Field description
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Result = OPI_Airtable.GetNumberField("Number");
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"name": "Number",
|
||||
"type": "number",
|
||||
"options": {
|
||||
"precision": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -1,36 +0,0 @@
|
||||
---
|
||||
sidebar_position: 9
|
||||
---
|
||||
|
||||
# Get field (phone)
|
||||
Gets the description of a phone number field
|
||||
|
||||
|
||||
|
||||
`Function GetPhoneField(Val Name) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Name | --title | String | Field name |
|
||||
|
||||
|
||||
Returns: Structure - Field description
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Result = OPI_Airtable.GetPhoneField("Phone");
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"name": "Phone",
|
||||
"type": "phoneNumber"
|
||||
}
|
||||
```
|
||||
39
docs/en/md/Airtable/Working-with-fields/Get-phone-field.mdx
Normal file
39
docs/en/md/Airtable/Working-with-fields/Get-phone-field.mdx
Normal file
@ -0,0 +1,39 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 9
|
||||
---
|
||||
|
||||
# Get field (phone)
|
||||
Gets the description of a phone number field
|
||||
|
||||
|
||||
|
||||
`Function GetPhoneField(Val Name) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Name | --title | String | Field name |
|
||||
|
||||
|
||||
Returns: Structure - Field description
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Result = OPI_Airtable.GetPhoneField("Phone");
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"name": "Phone",
|
||||
"type": "phoneNumber"
|
||||
}
|
||||
```
|
||||
@ -1,36 +0,0 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# Get field (string)
|
||||
Gets the description of a string field
|
||||
|
||||
|
||||
|
||||
`Function GetStringField(Val Name) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Name | --title | String | New field name |
|
||||
|
||||
|
||||
Returns: Structure - Field description
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Result = OPI_Airtable.GetStringField("String");
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"name": "String",
|
||||
"type": "richText"
|
||||
}
|
||||
```
|
||||
39
docs/en/md/Airtable/Working-with-fields/Get-string-field.mdx
Normal file
39
docs/en/md/Airtable/Working-with-fields/Get-string-field.mdx
Normal file
@ -0,0 +1,39 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# Get field (string)
|
||||
Gets the description of a string field
|
||||
|
||||
|
||||
|
||||
`Function GetStringField(Val Name) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Name | --title | String | New field name |
|
||||
|
||||
|
||||
Returns: Structure - Field description
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Result = OPI_Airtable.GetStringField("String");
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"name": "String",
|
||||
"type": "richText"
|
||||
}
|
||||
```
|
||||
@ -1,54 +0,0 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Modify field
|
||||
Changes the name and/or description of an existing table field
|
||||
|
||||
|
||||
|
||||
`Function ModifyField(Val Token, Val Base, Val Table, Val Field, Val Name = "", Val Description = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Token | --token | String | Token |
|
||||
| Base | --base | String | Base identifier Base |
|
||||
| Table | --table | String | Table identifier |
|
||||
| Field | --field | String | Field identifier |
|
||||
| Name | --title | String | New name |
|
||||
| Description | --description | String | New description |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON response from Airtable
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d...";
|
||||
Base = "appESy99HYCLbuWlV";
|
||||
Table = "tbl5gZLQ8i5xKuVTy";
|
||||
Field = "fldzPMAQ2obgGcvxG";
|
||||
|
||||
Name = String(New UUID) + "(change.)";
|
||||
Description = "New description";
|
||||
|
||||
Result = OPI_Airtable.ModifyField(Token, Base, Table, Field, Name, Description);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"type": "number",
|
||||
"options": {
|
||||
"precision": 0
|
||||
},
|
||||
"id": "fldDqI1OXajeQw5Gg",
|
||||
"name": "2cf91139-d111-4599-87bf-e3510ea23584(change.)",
|
||||
"description": "New description"
|
||||
}
|
||||
```
|
||||
57
docs/en/md/Airtable/Working-with-fields/Modify-field.mdx
Normal file
57
docs/en/md/Airtable/Working-with-fields/Modify-field.mdx
Normal file
@ -0,0 +1,57 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Modify field
|
||||
Changes the name and/or description of an existing table field
|
||||
|
||||
|
||||
|
||||
`Function ModifyField(Val Token, Val Base, Val Table, Val Field, Val Name = "", Val Description = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Token | --token | String | Token |
|
||||
| Base | --base | String | Base identifier Base |
|
||||
| Table | --table | String | Table identifier |
|
||||
| Field | --field | String | Field identifier |
|
||||
| Name | --title | String | New name |
|
||||
| Description | --description | String | New description |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON response from Airtable
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d...";
|
||||
Base = "appESy99HYCLbuWlV";
|
||||
Table = "tbl5gZLQ8i5xKuVTy";
|
||||
Field = "fldzPMAQ2obgGcvxG";
|
||||
|
||||
Name = String(New UUID) + "(change.)";
|
||||
Description = "New description";
|
||||
|
||||
Result = OPI_Airtable.ModifyField(Token, Base, Table, Field, Name, Description);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"type": "number",
|
||||
"options": {
|
||||
"precision": 0
|
||||
},
|
||||
"id": "fldDqI1OXajeQw5Gg",
|
||||
"name": "2cf91139-d111-4599-87bf-e3510ea23584(change.)",
|
||||
"description": "New description"
|
||||
}
|
||||
```
|
||||
@ -1,78 +0,0 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Create new subfolder
|
||||
Create new folder inside another folder
|
||||
|
||||
|
||||
|
||||
`Function CreateSubfolder(Val URL, Val FolderID, Val Name, Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| FolderID | --folderid | String, Number | Parent folder identifier |
|
||||
| Name | --title | String | Name of new folder |
|
||||
| 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: [disk.folder.addsubfolder](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_addsubfolder.php)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
FolderID = "12882";
|
||||
Name = "New subfolder";
|
||||
Filename2 = "New subfolder 2";
|
||||
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
|
||||
Result = OPI_Bitrix24.CreateSubfolder(URL, FolderID, Filename2);
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
|
||||
Result = OPI_Bitrix24.CreateSubfolder(URL, FolderID, Name, Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": {
|
||||
"ID": 12586,
|
||||
"NAME": "New subfolder",
|
||||
"CODE": null,
|
||||
"STORAGE_ID": "3",
|
||||
"TYPE": "folder",
|
||||
"REAL_OBJECT_ID": 12586,
|
||||
"PARENT_ID": "12582",
|
||||
"DELETED_TYPE": 0,
|
||||
"CREATE_TIME": "2024-10-09T09:20:24+03:00",
|
||||
"UPDATE_TIME": "2024-10-09T09:20:24+03:00",
|
||||
"DELETE_TIME": null,
|
||||
"CREATED_BY": "1",
|
||||
"UPDATED_BY": "1",
|
||||
"DELETED_BY": null,
|
||||
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog/New subfolder"
|
||||
},
|
||||
"time": {
|
||||
"start": 1728454824.78198,
|
||||
"finish": 1728454824.8632,
|
||||
"duration": 0.0812170505523682,
|
||||
"processing": 0.0518698692321777,
|
||||
"date_start": "2024-10-09T09:20:24+03:00",
|
||||
"date_finish": "2024-10-09T09:20:24+03:00",
|
||||
"operating_reset_at": 1728455424,
|
||||
"operating": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
81
docs/en/md/Bitrix24/Catalogs-managment/Create-subfolder.mdx
Normal file
81
docs/en/md/Bitrix24/Catalogs-managment/Create-subfolder.mdx
Normal file
@ -0,0 +1,81 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Create new subfolder
|
||||
Create new folder inside another folder
|
||||
|
||||
|
||||
|
||||
`Function CreateSubfolder(Val URL, Val FolderID, Val Name, Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| FolderID | --folderid | String, Number | Parent folder identifier |
|
||||
| Name | --title | String | Name of new folder |
|
||||
| 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: [disk.folder.addsubfolder](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_addsubfolder.php)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
FolderID = "12882";
|
||||
Name = "New subfolder";
|
||||
Filename2 = "New subfolder 2";
|
||||
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
|
||||
Result = OPI_Bitrix24.CreateSubfolder(URL, FolderID, Filename2);
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
|
||||
Result = OPI_Bitrix24.CreateSubfolder(URL, FolderID, Name, Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": {
|
||||
"ID": 12586,
|
||||
"NAME": "New subfolder",
|
||||
"CODE": null,
|
||||
"STORAGE_ID": "3",
|
||||
"TYPE": "folder",
|
||||
"REAL_OBJECT_ID": 12586,
|
||||
"PARENT_ID": "12582",
|
||||
"DELETED_TYPE": 0,
|
||||
"CREATE_TIME": "2024-10-09T09:20:24+03:00",
|
||||
"UPDATE_TIME": "2024-10-09T09:20:24+03:00",
|
||||
"DELETE_TIME": null,
|
||||
"CREATED_BY": "1",
|
||||
"UPDATED_BY": "1",
|
||||
"DELETED_BY": null,
|
||||
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog/New subfolder"
|
||||
},
|
||||
"time": {
|
||||
"start": 1728454824.78198,
|
||||
"finish": 1728454824.8632,
|
||||
"duration": 0.0812170505523682,
|
||||
"processing": 0.0518698692321777,
|
||||
"date_start": "2024-10-09T09:20:24+03:00",
|
||||
"date_finish": "2024-10-09T09:20:24+03:00",
|
||||
"operating_reset_at": 1728455424,
|
||||
"operating": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -1,59 +0,0 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
---
|
||||
|
||||
# Delete folder
|
||||
Remove folder with subfolders
|
||||
|
||||
|
||||
|
||||
`Function DeleteFolder(Val URL, Val FolderID, Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| FolderID | --folderid | String, Number | ID of folder to be deleted |
|
||||
| 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: [disk.folder.deletetree](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_deletetree.php)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
FolderID = "12880";
|
||||
|
||||
Result = OPI_Bitrix24.DeleteFolder(URL, FolderID);
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
FolderID = "12882";
|
||||
|
||||
Result = OPI_Bitrix24.DeleteFolder(URL, FolderID, Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": true,
|
||||
"time": {
|
||||
"start": 1728454830.52802,
|
||||
"finish": 1728454830.60905,
|
||||
"duration": 0.0810229778289795,
|
||||
"processing": 0.0520169734954834,
|
||||
"date_start": "2024-10-09T09:20:30+03:00",
|
||||
"date_finish": "2024-10-09T09:20:30+03:00",
|
||||
"operating_reset_at": 1728455430,
|
||||
"operating": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
62
docs/en/md/Bitrix24/Catalogs-managment/Delete-folder.mdx
Normal file
62
docs/en/md/Bitrix24/Catalogs-managment/Delete-folder.mdx
Normal file
@ -0,0 +1,62 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 5
|
||||
---
|
||||
|
||||
# Delete folder
|
||||
Remove folder with subfolders
|
||||
|
||||
|
||||
|
||||
`Function DeleteFolder(Val URL, Val FolderID, Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| FolderID | --folderid | String, Number | ID of folder to be deleted |
|
||||
| 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: [disk.folder.deletetree](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_deletetree.php)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
FolderID = "12880";
|
||||
|
||||
Result = OPI_Bitrix24.DeleteFolder(URL, FolderID);
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
FolderID = "12882";
|
||||
|
||||
Result = OPI_Bitrix24.DeleteFolder(URL, FolderID, Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": true,
|
||||
"time": {
|
||||
"start": 1728454830.52802,
|
||||
"finish": 1728454830.60905,
|
||||
"duration": 0.0810229778289795,
|
||||
"processing": 0.0520169734954834,
|
||||
"date_start": "2024-10-09T09:20:30+03:00",
|
||||
"date_finish": "2024-10-09T09:20:30+03:00",
|
||||
"operating_reset_at": 1728455430,
|
||||
"operating": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -1,58 +0,0 @@
|
||||
---
|
||||
sidebar_position: 6
|
||||
---
|
||||
|
||||
# Get external link for folder
|
||||
Get external link to folder
|
||||
|
||||
|
||||
|
||||
`Function GetFolderExternalLink(Val URL, Val FolderID, Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| FolderID | --folderid | String, Number | Folder identifier |
|
||||
| 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: [disk.folder.getExternalLink](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_getexternallink.php)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
FolderID = "12882";
|
||||
|
||||
Result = OPI_Bitrix24.GetFolderExternalLink(URL, FolderID);
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
|
||||
Result = OPI_Bitrix24.GetFolderExternalLink(URL, FolderID, Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": "https://b24-ar17wx.bitrix24.by/~arC9o",
|
||||
"time": {
|
||||
"start": 1728454824.46489,
|
||||
"finish": 1728454824.50162,
|
||||
"duration": 0.0367348194122314,
|
||||
"processing": 0.00669717788696289,
|
||||
"date_start": "2024-10-09T09:20:24+03:00",
|
||||
"date_finish": "2024-10-09T09:20:24+03:00",
|
||||
"operating_reset_at": 1728455424,
|
||||
"operating": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -0,0 +1,61 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 6
|
||||
---
|
||||
|
||||
# Get external link for folder
|
||||
Get external link to folder
|
||||
|
||||
|
||||
|
||||
`Function GetFolderExternalLink(Val URL, Val FolderID, Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| FolderID | --folderid | String, Number | Folder identifier |
|
||||
| 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: [disk.folder.getExternalLink](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_getexternallink.php)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
FolderID = "12882";
|
||||
|
||||
Result = OPI_Bitrix24.GetFolderExternalLink(URL, FolderID);
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
|
||||
Result = OPI_Bitrix24.GetFolderExternalLink(URL, FolderID, Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": "https://b24-ar17wx.bitrix24.by/~arC9o",
|
||||
"time": {
|
||||
"start": 1728454824.46489,
|
||||
"finish": 1728454824.50162,
|
||||
"duration": 0.0367348194122314,
|
||||
"processing": 0.00669717788696289,
|
||||
"date_start": "2024-10-09T09:20:24+03:00",
|
||||
"date_finish": "2024-10-09T09:20:24+03:00",
|
||||
"operating_reset_at": 1728455424,
|
||||
"operating": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -1,56 +0,0 @@
|
||||
---
|
||||
sidebar_position: 11
|
||||
---
|
||||
|
||||
# Get fields structure for folder items filter
|
||||
Returns filter structure for child folder items
|
||||
|
||||
|
||||
|
||||
`Function GetFolderFilterStructure(Val URL, Val Clear = False, Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| Clear | --empty | Boolean | True > structure with empty values, False > field types at values |
|
||||
| Token | --token | String | Access token, when app auth method used |
|
||||
|
||||
|
||||
Returns: Structure of KeyAndValue - Fields structure
|
||||
|
||||
<br/>
|
||||
|
||||
:::tip
|
||||
Method at API documentation: [disk.folder.getfields](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_getfields.php)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
|
||||
Result = OPI_Bitrix24.GetFolderFilterStructure(URL);
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
|
||||
Result = OPI_Bitrix24.GetFolderFilterStructure(URL, True, Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"ID": "",
|
||||
"NAME": "",
|
||||
"TYPE": "",
|
||||
"CODE": "",
|
||||
"STORAGE_ID": "",
|
||||
"PARENT_ID": "",
|
||||
"CREATE_TIME": "",
|
||||
"UPDATE_TIME": "",
|
||||
"DELETE_TIME": "",
|
||||
"DELETED_TYPE": ""
|
||||
}
|
||||
```
|
||||
@ -0,0 +1,59 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 11
|
||||
---
|
||||
|
||||
# Get fields structure for folder items filter
|
||||
Returns filter structure for child folder items
|
||||
|
||||
|
||||
|
||||
`Function GetFolderFilterStructure(Val URL, Val Clear = False, Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| Clear | --empty | Boolean | True > structure with empty values, False > field types at values |
|
||||
| Token | --token | String | Access token, when app auth method used |
|
||||
|
||||
|
||||
Returns: Structure of KeyAndValue - Fields structure
|
||||
|
||||
<br/>
|
||||
|
||||
:::tip
|
||||
Method at API documentation: [disk.folder.getfields](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_getfields.php)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
|
||||
Result = OPI_Bitrix24.GetFolderFilterStructure(URL);
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
|
||||
Result = OPI_Bitrix24.GetFolderFilterStructure(URL, True, Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"ID": "",
|
||||
"NAME": "",
|
||||
"TYPE": "",
|
||||
"CODE": "",
|
||||
"STORAGE_ID": "",
|
||||
"PARENT_ID": "",
|
||||
"CREATE_TIME": "",
|
||||
"UPDATE_TIME": "",
|
||||
"DELETE_TIME": "",
|
||||
"DELETED_TYPE": ""
|
||||
}
|
||||
```
|
||||
@ -1,74 +0,0 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Get information about folder
|
||||
Get folder information
|
||||
|
||||
|
||||
|
||||
`Function GetFolderInformation(Val URL, Val FolderID, Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| FolderID | --folderid | String, Number | Folder identifier |
|
||||
| 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: [disk.folder.get](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_get.php)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
FolderID = "12882";
|
||||
|
||||
Result = OPI_Bitrix24.GetFolderInformation(URL, FolderID);
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
|
||||
Result = OPI_Bitrix24.GetFolderInformation(URL, FolderID, Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": {
|
||||
"ID": "12582",
|
||||
"NAME": "New catalog",
|
||||
"CODE": null,
|
||||
"STORAGE_ID": "3",
|
||||
"TYPE": "folder",
|
||||
"REAL_OBJECT_ID": "12582",
|
||||
"PARENT_ID": "3",
|
||||
"DELETED_TYPE": "0",
|
||||
"CREATE_TIME": "2024-10-09T09:20:23+03:00",
|
||||
"UPDATE_TIME": "2024-10-09T09:20:23+03:00",
|
||||
"DELETE_TIME": null,
|
||||
"CREATED_BY": "1",
|
||||
"UPDATED_BY": "1",
|
||||
"DELETED_BY": "0",
|
||||
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog"
|
||||
},
|
||||
"time": {
|
||||
"start": 1728454824.27792,
|
||||
"finish": 1728454824.31056,
|
||||
"duration": 0.0326480865478516,
|
||||
"processing": 0.00559186935424805,
|
||||
"date_start": "2024-10-09T09:20:24+03:00",
|
||||
"date_finish": "2024-10-09T09:20:24+03:00",
|
||||
"operating_reset_at": 1728455424,
|
||||
"operating": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -0,0 +1,77 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Get information about folder
|
||||
Get folder information
|
||||
|
||||
|
||||
|
||||
`Function GetFolderInformation(Val URL, Val FolderID, Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| FolderID | --folderid | String, Number | Folder identifier |
|
||||
| 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: [disk.folder.get](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_get.php)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
FolderID = "12882";
|
||||
|
||||
Result = OPI_Bitrix24.GetFolderInformation(URL, FolderID);
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
|
||||
Result = OPI_Bitrix24.GetFolderInformation(URL, FolderID, Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": {
|
||||
"ID": "12582",
|
||||
"NAME": "New catalog",
|
||||
"CODE": null,
|
||||
"STORAGE_ID": "3",
|
||||
"TYPE": "folder",
|
||||
"REAL_OBJECT_ID": "12582",
|
||||
"PARENT_ID": "3",
|
||||
"DELETED_TYPE": "0",
|
||||
"CREATE_TIME": "2024-10-09T09:20:23+03:00",
|
||||
"UPDATE_TIME": "2024-10-09T09:20:23+03:00",
|
||||
"DELETE_TIME": null,
|
||||
"CREATED_BY": "1",
|
||||
"UPDATED_BY": "1",
|
||||
"DELETED_BY": "0",
|
||||
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog"
|
||||
},
|
||||
"time": {
|
||||
"start": 1728454824.27792,
|
||||
"finish": 1728454824.31056,
|
||||
"duration": 0.0326480865478516,
|
||||
"processing": 0.00559186935424805,
|
||||
"date_start": "2024-10-09T09:20:24+03:00",
|
||||
"date_finish": "2024-10-09T09:20:24+03:00",
|
||||
"operating_reset_at": 1728455424,
|
||||
"operating": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -1,115 +0,0 @@
|
||||
---
|
||||
sidebar_position: 7
|
||||
---
|
||||
|
||||
# Get folder child elements
|
||||
Get folder child elements
|
||||
|
||||
|
||||
|
||||
`Function GetFolderItems(Val URL, Val FolderID, Val Filter = "", Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| FolderID | --folderid | String, Number | Folder identifier |
|
||||
| Filter | --filter | Structure of KeyAndValue | Items filter (see GetFolderFilterStructure) |
|
||||
| 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: [disk.folder.getchildren](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_getchildren.php)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
FolderID = "12882";
|
||||
|
||||
Result = OPI_Bitrix24.GetFolderItems(URL, FolderID);
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
|
||||
Result = OPI_Bitrix24.GetFolderItems(URL, FolderID, , Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": [
|
||||
{
|
||||
"ID": "12584",
|
||||
"NAME": "New subfolder 2",
|
||||
"CODE": null,
|
||||
"STORAGE_ID": "3",
|
||||
"TYPE": "folder",
|
||||
"REAL_OBJECT_ID": "12584",
|
||||
"PARENT_ID": "12582",
|
||||
"DELETED_TYPE": "0",
|
||||
"CREATE_TIME": "2024-10-09T09:20:24+03:00",
|
||||
"UPDATE_TIME": "2024-10-09T09:20:25+03:00",
|
||||
"DELETE_TIME": null,
|
||||
"CREATED_BY": "1",
|
||||
"UPDATED_BY": "1",
|
||||
"DELETED_BY": "0",
|
||||
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog/New subfolder 2"
|
||||
},
|
||||
{
|
||||
"ID": "12586",
|
||||
"NAME": "New subfolder",
|
||||
"CODE": null,
|
||||
"STORAGE_ID": "3",
|
||||
"TYPE": "folder",
|
||||
"REAL_OBJECT_ID": "12586",
|
||||
"PARENT_ID": "12582",
|
||||
"DELETED_TYPE": "0",
|
||||
"CREATE_TIME": "2024-10-09T09:20:24+03:00",
|
||||
"UPDATE_TIME": "2024-10-09T09:20:25+03:00",
|
||||
"DELETE_TIME": null,
|
||||
"CREATED_BY": "1",
|
||||
"UPDATED_BY": "1",
|
||||
"DELETED_BY": "0",
|
||||
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog/New subfolder"
|
||||
},
|
||||
{
|
||||
"ID": "12604",
|
||||
"NAME": "New file name.jpg",
|
||||
"CODE": null,
|
||||
"STORAGE_ID": "3",
|
||||
"TYPE": "file",
|
||||
"PARENT_ID": "12582",
|
||||
"DELETED_TYPE": "0",
|
||||
"GLOBAL_CONTENT_VERSION": "1",
|
||||
"FILE_ID": "8678",
|
||||
"SIZE": "805189",
|
||||
"CREATE_TIME": "2024-10-09T09:20:28+03:00",
|
||||
"UPDATE_TIME": "2024-10-09T09:20:28+03:00",
|
||||
"DELETE_TIME": null,
|
||||
"CREATED_BY": "1",
|
||||
"UPDATED_BY": "1",
|
||||
"DELETED_BY": "0",
|
||||
"DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=6b2e0667006e9f06006b12e4000000010000072c4914d2a629a27f8e468fd6a8ba64ff&token=disk%7CaWQ9MTI2MDQmXz03bHFpaTl0bjV6aFk1SnFVY0szYU5RMVNSRHlWb2ZwcA%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU1USTJNRFFtWHowM2JIRnBhVGwwYmpWNmFGazFTbkZWWTBzellVNVJNVk5TUkhsV2IyWndjQT09fDZiMmUwNjY3MDA2ZTlmMDYwMDZiMTJlNDAwMDAwMDAxMDAwMDA3MmM0OTE0ZDJhNjI5YTI3ZjhlNDY4ZmQ2YThiYTY0ZmYi.SL6HjOaIdsjTX1Tik1rou9x26mZ6E8LBmyKI4jcVsps%3D",
|
||||
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/New catalog/New file name.jpg"
|
||||
}
|
||||
],
|
||||
"total": 3,
|
||||
"time": {
|
||||
"start": 1728454829.29148,
|
||||
"finish": 1728454829.32633,
|
||||
"duration": 0.0348570346832275,
|
||||
"processing": 0.00847411155700684,
|
||||
"date_start": "2024-10-09T09:20:29+03:00",
|
||||
"date_finish": "2024-10-09T09:20:29+03:00",
|
||||
"operating_reset_at": 1728455429,
|
||||
"operating": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
118
docs/en/md/Bitrix24/Catalogs-managment/Get-folder-items.mdx
Normal file
118
docs/en/md/Bitrix24/Catalogs-managment/Get-folder-items.mdx
Normal file
@ -0,0 +1,118 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 7
|
||||
---
|
||||
|
||||
# Get folder child elements
|
||||
Get folder child elements
|
||||
|
||||
|
||||
|
||||
`Function GetFolderItems(Val URL, Val FolderID, Val Filter = "", Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| FolderID | --folderid | String, Number | Folder identifier |
|
||||
| Filter | --filter | Structure of KeyAndValue | Items filter (see GetFolderFilterStructure) |
|
||||
| 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: [disk.folder.getchildren](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_getchildren.php)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
FolderID = "12882";
|
||||
|
||||
Result = OPI_Bitrix24.GetFolderItems(URL, FolderID);
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
|
||||
Result = OPI_Bitrix24.GetFolderItems(URL, FolderID, , Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": [
|
||||
{
|
||||
"ID": "12584",
|
||||
"NAME": "New subfolder 2",
|
||||
"CODE": null,
|
||||
"STORAGE_ID": "3",
|
||||
"TYPE": "folder",
|
||||
"REAL_OBJECT_ID": "12584",
|
||||
"PARENT_ID": "12582",
|
||||
"DELETED_TYPE": "0",
|
||||
"CREATE_TIME": "2024-10-09T09:20:24+03:00",
|
||||
"UPDATE_TIME": "2024-10-09T09:20:25+03:00",
|
||||
"DELETE_TIME": null,
|
||||
"CREATED_BY": "1",
|
||||
"UPDATED_BY": "1",
|
||||
"DELETED_BY": "0",
|
||||
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog/New subfolder 2"
|
||||
},
|
||||
{
|
||||
"ID": "12586",
|
||||
"NAME": "New subfolder",
|
||||
"CODE": null,
|
||||
"STORAGE_ID": "3",
|
||||
"TYPE": "folder",
|
||||
"REAL_OBJECT_ID": "12586",
|
||||
"PARENT_ID": "12582",
|
||||
"DELETED_TYPE": "0",
|
||||
"CREATE_TIME": "2024-10-09T09:20:24+03:00",
|
||||
"UPDATE_TIME": "2024-10-09T09:20:25+03:00",
|
||||
"DELETE_TIME": null,
|
||||
"CREATED_BY": "1",
|
||||
"UPDATED_BY": "1",
|
||||
"DELETED_BY": "0",
|
||||
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog/New subfolder"
|
||||
},
|
||||
{
|
||||
"ID": "12604",
|
||||
"NAME": "New file name.jpg",
|
||||
"CODE": null,
|
||||
"STORAGE_ID": "3",
|
||||
"TYPE": "file",
|
||||
"PARENT_ID": "12582",
|
||||
"DELETED_TYPE": "0",
|
||||
"GLOBAL_CONTENT_VERSION": "1",
|
||||
"FILE_ID": "8678",
|
||||
"SIZE": "805189",
|
||||
"CREATE_TIME": "2024-10-09T09:20:28+03:00",
|
||||
"UPDATE_TIME": "2024-10-09T09:20:28+03:00",
|
||||
"DELETE_TIME": null,
|
||||
"CREATED_BY": "1",
|
||||
"UPDATED_BY": "1",
|
||||
"DELETED_BY": "0",
|
||||
"DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=6b2e0667006e9f06006b12e4000000010000072c4914d2a629a27f8e468fd6a8ba64ff&token=disk%7CaWQ9MTI2MDQmXz03bHFpaTl0bjV6aFk1SnFVY0szYU5RMVNSRHlWb2ZwcA%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU1USTJNRFFtWHowM2JIRnBhVGwwYmpWNmFGazFTbkZWWTBzellVNVJNVk5TUkhsV2IyWndjQT09fDZiMmUwNjY3MDA2ZTlmMDYwMDZiMTJlNDAwMDAwMDAxMDAwMDA3MmM0OTE0ZDJhNjI5YTI3ZjhlNDY4ZmQ2YThiYTY0ZmYi.SL6HjOaIdsjTX1Tik1rou9x26mZ6E8LBmyKI4jcVsps%3D",
|
||||
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/New catalog/New file name.jpg"
|
||||
}
|
||||
],
|
||||
"total": 3,
|
||||
"time": {
|
||||
"start": 1728454829.29148,
|
||||
"finish": 1728454829.32633,
|
||||
"duration": 0.0348570346832275,
|
||||
"processing": 0.00847411155700684,
|
||||
"date_start": "2024-10-09T09:20:29+03:00",
|
||||
"date_finish": "2024-10-09T09:20:29+03:00",
|
||||
"operating_reset_at": 1728455429,
|
||||
"operating": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -1,82 +0,0 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# Copy folder
|
||||
Copy one folder to another
|
||||
|
||||
|
||||
|
||||
`Function MakeFolderCopy(Val URL, Val FolderID, Val DestinationID, Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| FolderID | --folderid | String, Number | Folder identifier |
|
||||
| DestinationID | --tagetid | String, Number | ID of target folder |
|
||||
| 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: [disk.folder.copyto](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_copyto.php)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
DestinationID = "12884";
|
||||
FolderID = "12886";
|
||||
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
|
||||
Result = OPI_Bitrix24.MakeFolderCopy(URL, FolderID, DestinationID);
|
||||
|
||||
DestinationID = "12886";
|
||||
FolderID = "12884";
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
|
||||
Result = OPI_Bitrix24.MakeFolderCopy(URL, FolderID, DestinationID, Token);
|
||||
|
||||
OPI_TestDataRetrieval.Check_BitrixObject(Result);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": {
|
||||
"ID": 12592,
|
||||
"NAME": "New subfolder 2",
|
||||
"CODE": null,
|
||||
"STORAGE_ID": "3",
|
||||
"TYPE": "folder",
|
||||
"REAL_OBJECT_ID": 12592,
|
||||
"PARENT_ID": "12586",
|
||||
"DELETED_TYPE": 0,
|
||||
"CREATE_TIME": "2024-10-09T09:20:25+03:00",
|
||||
"UPDATE_TIME": "2024-10-09T09:20:25+03:00",
|
||||
"DELETE_TIME": null,
|
||||
"CREATED_BY": "1",
|
||||
"UPDATED_BY": "1",
|
||||
"DELETED_BY": null,
|
||||
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog/New subfolder/New subfolder 2"
|
||||
},
|
||||
"time": {
|
||||
"start": 1728454825.37565,
|
||||
"finish": 1728454825.50996,
|
||||
"duration": 0.134312868118286,
|
||||
"processing": 0.109131097793579,
|
||||
"date_start": "2024-10-09T09:20:25+03:00",
|
||||
"date_finish": "2024-10-09T09:20:25+03:00",
|
||||
"operating_reset_at": 1728455425,
|
||||
"operating": 0.109107971191406
|
||||
}
|
||||
}
|
||||
```
|
||||
85
docs/en/md/Bitrix24/Catalogs-managment/Make-folder-copy.mdx
Normal file
85
docs/en/md/Bitrix24/Catalogs-managment/Make-folder-copy.mdx
Normal file
@ -0,0 +1,85 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# Copy folder
|
||||
Copy one folder to another
|
||||
|
||||
|
||||
|
||||
`Function MakeFolderCopy(Val URL, Val FolderID, Val DestinationID, Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| FolderID | --folderid | String, Number | Folder identifier |
|
||||
| DestinationID | --tagetid | String, Number | ID of target folder |
|
||||
| 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: [disk.folder.copyto](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_copyto.php)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
DestinationID = "12884";
|
||||
FolderID = "12886";
|
||||
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
|
||||
Result = OPI_Bitrix24.MakeFolderCopy(URL, FolderID, DestinationID);
|
||||
|
||||
DestinationID = "12886";
|
||||
FolderID = "12884";
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
|
||||
Result = OPI_Bitrix24.MakeFolderCopy(URL, FolderID, DestinationID, Token);
|
||||
|
||||
OPI_TestDataRetrieval.Check_BitrixObject(Result);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": {
|
||||
"ID": 12592,
|
||||
"NAME": "New subfolder 2",
|
||||
"CODE": null,
|
||||
"STORAGE_ID": "3",
|
||||
"TYPE": "folder",
|
||||
"REAL_OBJECT_ID": 12592,
|
||||
"PARENT_ID": "12586",
|
||||
"DELETED_TYPE": 0,
|
||||
"CREATE_TIME": "2024-10-09T09:20:25+03:00",
|
||||
"UPDATE_TIME": "2024-10-09T09:20:25+03:00",
|
||||
"DELETE_TIME": null,
|
||||
"CREATED_BY": "1",
|
||||
"UPDATED_BY": "1",
|
||||
"DELETED_BY": null,
|
||||
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog/New subfolder/New subfolder 2"
|
||||
},
|
||||
"time": {
|
||||
"start": 1728454825.37565,
|
||||
"finish": 1728454825.50996,
|
||||
"duration": 0.134312868118286,
|
||||
"processing": 0.109131097793579,
|
||||
"date_start": "2024-10-09T09:20:25+03:00",
|
||||
"date_finish": "2024-10-09T09:20:25+03:00",
|
||||
"operating_reset_at": 1728455425,
|
||||
"operating": 0.109107971191406
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -1,74 +0,0 @@
|
||||
---
|
||||
sidebar_position: 8
|
||||
---
|
||||
|
||||
# Mark folder as deleted
|
||||
Move folder to recycle bin
|
||||
|
||||
|
||||
|
||||
`Function MarkFolderAsDeleted(Val URL, Val FolderID, Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| FolderID | --folderid | String, Number | Folder identifier |
|
||||
| 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: [disk.folder.markdeleted](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_markdeleted.php)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
FolderID = "12882";
|
||||
|
||||
Result = OPI_Bitrix24.MarkFolderAsDeleted(URL, FolderID);
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
|
||||
Result = OPI_Bitrix24.MarkFolderAsDeleted(URL, FolderID, Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": {
|
||||
"ID": "12582",
|
||||
"NAME": "New catalog",
|
||||
"CODE": null,
|
||||
"STORAGE_ID": "3",
|
||||
"TYPE": "folder",
|
||||
"REAL_OBJECT_ID": "12582",
|
||||
"PARENT_ID": "3",
|
||||
"DELETED_TYPE": "3",
|
||||
"CREATE_TIME": "2024-10-09T09:20:23+03:00",
|
||||
"UPDATE_TIME": "2024-10-09T09:20:28+03:00",
|
||||
"DELETE_TIME": "2024-10-09T09:20:29+03:00",
|
||||
"CREATED_BY": "1",
|
||||
"UPDATED_BY": "1",
|
||||
"DELETED_BY": "1",
|
||||
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog"
|
||||
},
|
||||
"time": {
|
||||
"start": 1728454829.76518,
|
||||
"finish": 1728454829.80079,
|
||||
"duration": 0.0356080532073975,
|
||||
"processing": 0.00615215301513672,
|
||||
"date_start": "2024-10-09T09:20:29+03:00",
|
||||
"date_finish": "2024-10-09T09:20:29+03:00",
|
||||
"operating_reset_at": 1728455429,
|
||||
"operating": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -0,0 +1,77 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 8
|
||||
---
|
||||
|
||||
# Mark folder as deleted
|
||||
Move folder to recycle bin
|
||||
|
||||
|
||||
|
||||
`Function MarkFolderAsDeleted(Val URL, Val FolderID, Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| FolderID | --folderid | String, Number | Folder identifier |
|
||||
| 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: [disk.folder.markdeleted](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_markdeleted.php)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
FolderID = "12882";
|
||||
|
||||
Result = OPI_Bitrix24.MarkFolderAsDeleted(URL, FolderID);
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
|
||||
Result = OPI_Bitrix24.MarkFolderAsDeleted(URL, FolderID, Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": {
|
||||
"ID": "12582",
|
||||
"NAME": "New catalog",
|
||||
"CODE": null,
|
||||
"STORAGE_ID": "3",
|
||||
"TYPE": "folder",
|
||||
"REAL_OBJECT_ID": "12582",
|
||||
"PARENT_ID": "3",
|
||||
"DELETED_TYPE": "3",
|
||||
"CREATE_TIME": "2024-10-09T09:20:23+03:00",
|
||||
"UPDATE_TIME": "2024-10-09T09:20:28+03:00",
|
||||
"DELETE_TIME": "2024-10-09T09:20:29+03:00",
|
||||
"CREATED_BY": "1",
|
||||
"UPDATED_BY": "1",
|
||||
"DELETED_BY": "1",
|
||||
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog"
|
||||
},
|
||||
"time": {
|
||||
"start": 1728454829.76518,
|
||||
"finish": 1728454829.80079,
|
||||
"duration": 0.0356080532073975,
|
||||
"processing": 0.00615215301513672,
|
||||
"date_start": "2024-10-09T09:20:29+03:00",
|
||||
"date_finish": "2024-10-09T09:20:29+03:00",
|
||||
"operating_reset_at": 1728455429,
|
||||
"operating": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -1,81 +0,0 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
---
|
||||
|
||||
# Move folder
|
||||
Moves one folder inside another
|
||||
|
||||
|
||||
|
||||
`Function MoveFolder(Val URL, Val FolderID, Val DestinationID, Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| FolderID | --folderid | String, Number | Folder identifier |
|
||||
| DestinationID | --tagetid | String, Number | ID of target folder |
|
||||
| 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: [disk.folder.moveto](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_moveto.php)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
DestinationID = "12880";
|
||||
FolderID = "12886";
|
||||
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
|
||||
Result = OPI_Bitrix24.MoveFolder(URL, FolderID, DestinationID);
|
||||
|
||||
FolderID = "12884";
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
|
||||
Result = OPI_Bitrix24.MoveFolder(URL, FolderID, DestinationID, Token);
|
||||
|
||||
OPI_TestDataRetrieval.Check_BitrixObject(Result);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": {
|
||||
"ID": "12584",
|
||||
"NAME": "New subfolder 2",
|
||||
"CODE": null,
|
||||
"STORAGE_ID": "3",
|
||||
"TYPE": "folder",
|
||||
"REAL_OBJECT_ID": "12584",
|
||||
"PARENT_ID": 12580,
|
||||
"DELETED_TYPE": "0",
|
||||
"CREATE_TIME": "2024-10-09T09:20:24+03:00",
|
||||
"UPDATE_TIME": "2024-10-09T09:20:25+03:00",
|
||||
"DELETE_TIME": null,
|
||||
"CREATED_BY": "1",
|
||||
"UPDATED_BY": "1",
|
||||
"DELETED_BY": "0",
|
||||
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New folder 2/New subfolder 2"
|
||||
},
|
||||
"time": {
|
||||
"start": 1728454829.50812,
|
||||
"finish": 1728454829.56734,
|
||||
"duration": 0.0592169761657715,
|
||||
"processing": 0.0330197811126709,
|
||||
"date_start": "2024-10-09T09:20:29+03:00",
|
||||
"date_finish": "2024-10-09T09:20:29+03:00",
|
||||
"operating_reset_at": 1728455429,
|
||||
"operating": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
84
docs/en/md/Bitrix24/Catalogs-managment/Move-folder.mdx
Normal file
84
docs/en/md/Bitrix24/Catalogs-managment/Move-folder.mdx
Normal file
@ -0,0 +1,84 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 4
|
||||
---
|
||||
|
||||
# Move folder
|
||||
Moves one folder inside another
|
||||
|
||||
|
||||
|
||||
`Function MoveFolder(Val URL, Val FolderID, Val DestinationID, Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| FolderID | --folderid | String, Number | Folder identifier |
|
||||
| DestinationID | --tagetid | String, Number | ID of target folder |
|
||||
| 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: [disk.folder.moveto](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_moveto.php)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
DestinationID = "12880";
|
||||
FolderID = "12886";
|
||||
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
|
||||
Result = OPI_Bitrix24.MoveFolder(URL, FolderID, DestinationID);
|
||||
|
||||
FolderID = "12884";
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
|
||||
Result = OPI_Bitrix24.MoveFolder(URL, FolderID, DestinationID, Token);
|
||||
|
||||
OPI_TestDataRetrieval.Check_BitrixObject(Result);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": {
|
||||
"ID": "12584",
|
||||
"NAME": "New subfolder 2",
|
||||
"CODE": null,
|
||||
"STORAGE_ID": "3",
|
||||
"TYPE": "folder",
|
||||
"REAL_OBJECT_ID": "12584",
|
||||
"PARENT_ID": 12580,
|
||||
"DELETED_TYPE": "0",
|
||||
"CREATE_TIME": "2024-10-09T09:20:24+03:00",
|
||||
"UPDATE_TIME": "2024-10-09T09:20:25+03:00",
|
||||
"DELETE_TIME": null,
|
||||
"CREATED_BY": "1",
|
||||
"UPDATED_BY": "1",
|
||||
"DELETED_BY": "0",
|
||||
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New folder 2/New subfolder 2"
|
||||
},
|
||||
"time": {
|
||||
"start": 1728454829.50812,
|
||||
"finish": 1728454829.56734,
|
||||
"duration": 0.0592169761657715,
|
||||
"processing": 0.0330197811126709,
|
||||
"date_start": "2024-10-09T09:20:29+03:00",
|
||||
"date_finish": "2024-10-09T09:20:29+03:00",
|
||||
"operating_reset_at": 1728455429,
|
||||
"operating": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -1,79 +0,0 @@
|
||||
---
|
||||
sidebar_position: 10
|
||||
---
|
||||
|
||||
# Rename folder
|
||||
Change folder name
|
||||
|
||||
|
||||
|
||||
`Function RenameFolder(Val URL, Val FolderID, Val Name, Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| FolderID | --folderid | String, Number | Folder identifier |
|
||||
| Name | --title | String | New folders name |
|
||||
| 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: [disk.folder.rename](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_rename.php)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Name = "New catalog";
|
||||
Filename2 = "New folder 2";
|
||||
|
||||
FolderID2 = "12880";
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
|
||||
Result = OPI_Bitrix24.RenameFolder(URL, FolderID2, Filename2);
|
||||
|
||||
FolderID = "12882";
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
|
||||
Result = OPI_Bitrix24.RenameFolder(URL, FolderID, Name, Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": {
|
||||
"ID": "12582",
|
||||
"NAME": "New catalog",
|
||||
"CODE": null,
|
||||
"STORAGE_ID": "3",
|
||||
"TYPE": "folder",
|
||||
"REAL_OBJECT_ID": "12582",
|
||||
"PARENT_ID": "3",
|
||||
"DELETED_TYPE": "0",
|
||||
"CREATE_TIME": "2024-10-09T09:20:23+03:00",
|
||||
"UPDATE_TIME": "2024-10-09T09:20:23+03:00",
|
||||
"DELETE_TIME": null,
|
||||
"CREATED_BY": "1",
|
||||
"UPDATED_BY": "1",
|
||||
"DELETED_BY": "0",
|
||||
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog"
|
||||
},
|
||||
"time": {
|
||||
"start": 1728454824.0992,
|
||||
"finish": 1728454824.13256,
|
||||
"duration": 0.0333640575408936,
|
||||
"processing": 0.00759291648864746,
|
||||
"date_start": "2024-10-09T09:20:24+03:00",
|
||||
"date_finish": "2024-10-09T09:20:24+03:00",
|
||||
"operating_reset_at": 1728455424,
|
||||
"operating": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
82
docs/en/md/Bitrix24/Catalogs-managment/Rename-folder.mdx
Normal file
82
docs/en/md/Bitrix24/Catalogs-managment/Rename-folder.mdx
Normal file
@ -0,0 +1,82 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 10
|
||||
---
|
||||
|
||||
# Rename folder
|
||||
Change folder name
|
||||
|
||||
|
||||
|
||||
`Function RenameFolder(Val URL, Val FolderID, Val Name, Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| FolderID | --folderid | String, Number | Folder identifier |
|
||||
| Name | --title | String | New folders name |
|
||||
| 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: [disk.folder.rename](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_rename.php)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Name = "New catalog";
|
||||
Filename2 = "New folder 2";
|
||||
|
||||
FolderID2 = "12880";
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
|
||||
Result = OPI_Bitrix24.RenameFolder(URL, FolderID2, Filename2);
|
||||
|
||||
FolderID = "12882";
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
|
||||
Result = OPI_Bitrix24.RenameFolder(URL, FolderID, Name, Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": {
|
||||
"ID": "12582",
|
||||
"NAME": "New catalog",
|
||||
"CODE": null,
|
||||
"STORAGE_ID": "3",
|
||||
"TYPE": "folder",
|
||||
"REAL_OBJECT_ID": "12582",
|
||||
"PARENT_ID": "3",
|
||||
"DELETED_TYPE": "0",
|
||||
"CREATE_TIME": "2024-10-09T09:20:23+03:00",
|
||||
"UPDATE_TIME": "2024-10-09T09:20:23+03:00",
|
||||
"DELETE_TIME": null,
|
||||
"CREATED_BY": "1",
|
||||
"UPDATED_BY": "1",
|
||||
"DELETED_BY": "0",
|
||||
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog"
|
||||
},
|
||||
"time": {
|
||||
"start": 1728454824.0992,
|
||||
"finish": 1728454824.13256,
|
||||
"duration": 0.0333640575408936,
|
||||
"processing": 0.00759291648864746,
|
||||
"date_start": "2024-10-09T09:20:24+03:00",
|
||||
"date_finish": "2024-10-09T09:20:24+03:00",
|
||||
"operating_reset_at": 1728455424,
|
||||
"operating": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -1,74 +0,0 @@
|
||||
---
|
||||
sidebar_position: 9
|
||||
---
|
||||
|
||||
# Restore folder
|
||||
Resotre folder form recycle bin
|
||||
|
||||
|
||||
|
||||
`Function RestoreFolder(Val URL, Val FolderID, Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| FolderID | --folderid | String, Number | Folder identifier |
|
||||
| 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: [disk.folder.restore](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_restore.php)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
FolderID = "12882";
|
||||
|
||||
Result = OPI_Bitrix24.RestoreFolder(URL, FolderID);
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
|
||||
Result = OPI_Bitrix24.RestoreFolder(URL, FolderID, Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": {
|
||||
"ID": "12582",
|
||||
"NAME": "New catalog",
|
||||
"CODE": null,
|
||||
"STORAGE_ID": "3",
|
||||
"TYPE": "folder",
|
||||
"REAL_OBJECT_ID": "12582",
|
||||
"PARENT_ID": "3",
|
||||
"DELETED_TYPE": "0",
|
||||
"CREATE_TIME": "2024-10-09T09:20:23+03:00",
|
||||
"UPDATE_TIME": "2024-10-09T09:20:29+03:00",
|
||||
"DELETE_TIME": "2024-10-09T09:20:29+03:00",
|
||||
"CREATED_BY": "1",
|
||||
"UPDATED_BY": "1",
|
||||
"DELETED_BY": "1",
|
||||
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog"
|
||||
},
|
||||
"time": {
|
||||
"start": 1728454829.99146,
|
||||
"finish": 1728454830.02273,
|
||||
"duration": 0.031264066696167,
|
||||
"processing": 0.0063779354095459,
|
||||
"date_start": "2024-10-09T09:20:29+03:00",
|
||||
"date_finish": "2024-10-09T09:20:30+03:00",
|
||||
"operating_reset_at": 1728455430,
|
||||
"operating": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
77
docs/en/md/Bitrix24/Catalogs-managment/Restore-folder.mdx
Normal file
77
docs/en/md/Bitrix24/Catalogs-managment/Restore-folder.mdx
Normal file
@ -0,0 +1,77 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 9
|
||||
---
|
||||
|
||||
# Restore folder
|
||||
Resotre folder form recycle bin
|
||||
|
||||
|
||||
|
||||
`Function RestoreFolder(Val URL, Val FolderID, Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| FolderID | --folderid | String, Number | Folder identifier |
|
||||
| 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: [disk.folder.restore](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_restore.php)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
FolderID = "12882";
|
||||
|
||||
Result = OPI_Bitrix24.RestoreFolder(URL, FolderID);
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
|
||||
Result = OPI_Bitrix24.RestoreFolder(URL, FolderID, Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": {
|
||||
"ID": "12582",
|
||||
"NAME": "New catalog",
|
||||
"CODE": null,
|
||||
"STORAGE_ID": "3",
|
||||
"TYPE": "folder",
|
||||
"REAL_OBJECT_ID": "12582",
|
||||
"PARENT_ID": "3",
|
||||
"DELETED_TYPE": "0",
|
||||
"CREATE_TIME": "2024-10-09T09:20:23+03:00",
|
||||
"UPDATE_TIME": "2024-10-09T09:20:29+03:00",
|
||||
"DELETE_TIME": "2024-10-09T09:20:29+03:00",
|
||||
"CREATED_BY": "1",
|
||||
"UPDATED_BY": "1",
|
||||
"DELETED_BY": "1",
|
||||
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog"
|
||||
},
|
||||
"time": {
|
||||
"start": 1728454829.99146,
|
||||
"finish": 1728454830.02273,
|
||||
"duration": 0.031264066696167,
|
||||
"processing": 0.0063779354095459,
|
||||
"date_start": "2024-10-09T09:20:29+03:00",
|
||||
"date_finish": "2024-10-09T09:20:30+03:00",
|
||||
"operating_reset_at": 1728455430,
|
||||
"operating": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -1,66 +0,0 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
---
|
||||
|
||||
# Add users to chat
|
||||
Adds users to the chat by ID array
|
||||
|
||||
|
||||
|
||||
`Function AddUsersToChat(Val URL, Val ChatID, Val UserIDs, Val HideHistory = False, Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| ChatID | --chat | String, Number | Chat ID |
|
||||
| UserIDs | --users | Array of string, number | New members IDs |
|
||||
| HideHistory | --hide | Boolean | Hide old messages from new members |
|
||||
| Token | --token | String | Access token, when app auth method used |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
|
||||
|
||||
<br/>
|
||||
|
||||
:::tip
|
||||
Method at API documentation: [im.chat.user.add](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12097)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
ChatID = "1006";
|
||||
|
||||
UserIDs = New Array;
|
||||
UserIDs.Add(10);
|
||||
UserIDs.Add(12);
|
||||
|
||||
Result = OPI_Bitrix24.AddUsersToChat(URL, ChatID, UserIDs);
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
ChatID = "1008";
|
||||
UserID = 10;
|
||||
|
||||
Result = OPI_Bitrix24.AddUsersToChat(URL, ChatID, UserID, True, Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": true,
|
||||
"time": {
|
||||
"start": 1728454873.26338,
|
||||
"finish": 1728454873.34975,
|
||||
"duration": 0.0863678455352783,
|
||||
"processing": 0.0585901737213135,
|
||||
"date_start": "2024-10-09T09:21:13+03:00",
|
||||
"date_finish": "2024-10-09T09:21:13+03:00",
|
||||
"operating_reset_at": 1728455473,
|
||||
"operating": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -0,0 +1,69 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 5
|
||||
---
|
||||
|
||||
# Add users to chat
|
||||
Adds users to the chat by ID array
|
||||
|
||||
|
||||
|
||||
`Function AddUsersToChat(Val URL, Val ChatID, Val UserIDs, Val HideHistory = False, Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| ChatID | --chat | String, Number | Chat ID |
|
||||
| UserIDs | --users | Array of string, number | New members IDs |
|
||||
| HideHistory | --hide | Boolean | Hide old messages from new members |
|
||||
| Token | --token | String | Access token, when app auth method used |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
|
||||
|
||||
<br/>
|
||||
|
||||
:::tip
|
||||
Method at API documentation: [im.chat.user.add](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12097)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
ChatID = "1006";
|
||||
|
||||
UserIDs = New Array;
|
||||
UserIDs.Add(10);
|
||||
UserIDs.Add(12);
|
||||
|
||||
Result = OPI_Bitrix24.AddUsersToChat(URL, ChatID, UserIDs);
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
ChatID = "1008";
|
||||
UserID = 10;
|
||||
|
||||
Result = OPI_Bitrix24.AddUsersToChat(URL, ChatID, UserID, True, Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": true,
|
||||
"time": {
|
||||
"start": 1728454873.26338,
|
||||
"finish": 1728454873.34975,
|
||||
"duration": 0.0863678455352783,
|
||||
"processing": 0.0585901737213135,
|
||||
"date_start": "2024-10-09T09:21:13+03:00",
|
||||
"date_finish": "2024-10-09T09:21:13+03:00",
|
||||
"operating_reset_at": 1728455473,
|
||||
"operating": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -1,65 +0,0 @@
|
||||
---
|
||||
sidebar_position: 8
|
||||
---
|
||||
|
||||
# Change chat color
|
||||
Chat chat color for mobile app
|
||||
|
||||
|
||||
|
||||
`Function ChangeChatColor(Val URL, Val ChatID, Val Color, Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| ChatID | --chat | String, Number | Chat ID |
|
||||
| Color | --color | String | New chat color |
|
||||
| Token | --token | String | Access token, when app auth method used |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
|
||||
|
||||
<br/>
|
||||
|
||||
:::tip
|
||||
Method at API documentation: [im.chat.updateTitle](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12105)
|
||||
|
||||
Available colors: RED, GREEN, MINT, LIGHT_BLUE, DARK_BLUE, PURPLE, AQUA, PINK, LIME, BROWN, AZURE, KHAKI, SAND, MARENGO, GRAY, GRAPHITE
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
ChatID = "1006";
|
||||
|
||||
Color = "AZURE";
|
||||
|
||||
Result = OPI_Bitrix24.ChangeChatColor(URL, ChatID, Color);
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
|
||||
Color = "PURPLE";
|
||||
|
||||
Result = OPI_Bitrix24.ChangeChatColor(URL, ChatID, Color, Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": true,
|
||||
"time": {
|
||||
"start": 1728454888.85994,
|
||||
"finish": 1728454888.95268,
|
||||
"duration": 0.0927419662475586,
|
||||
"processing": 0.064525842666626,
|
||||
"date_start": "2024-10-09T09:21:28+03:00",
|
||||
"date_finish": "2024-10-09T09:21:28+03:00",
|
||||
"operating_reset_at": 1728455488,
|
||||
"operating": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -0,0 +1,68 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 8
|
||||
---
|
||||
|
||||
# Change chat color
|
||||
Chat chat color for mobile app
|
||||
|
||||
|
||||
|
||||
`Function ChangeChatColor(Val URL, Val ChatID, Val Color, Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| ChatID | --chat | String, Number | Chat ID |
|
||||
| Color | --color | String | New chat color |
|
||||
| Token | --token | String | Access token, when app auth method used |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
|
||||
|
||||
<br/>
|
||||
|
||||
:::tip
|
||||
Method at API documentation: [im.chat.updateTitle](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12105)
|
||||
|
||||
Available colors: RED, GREEN, MINT, LIGHT_BLUE, DARK_BLUE, PURPLE, AQUA, PINK, LIME, BROWN, AZURE, KHAKI, SAND, MARENGO, GRAY, GRAPHITE
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
ChatID = "1006";
|
||||
|
||||
Color = "AZURE";
|
||||
|
||||
Result = OPI_Bitrix24.ChangeChatColor(URL, ChatID, Color);
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
|
||||
Color = "PURPLE";
|
||||
|
||||
Result = OPI_Bitrix24.ChangeChatColor(URL, ChatID, Color, Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": true,
|
||||
"time": {
|
||||
"start": 1728454888.85994,
|
||||
"finish": 1728454888.95268,
|
||||
"duration": 0.0927419662475586,
|
||||
"processing": 0.064525842666626,
|
||||
"date_start": "2024-10-09T09:21:28+03:00",
|
||||
"date_finish": "2024-10-09T09:21:28+03:00",
|
||||
"operating_reset_at": 1728455488,
|
||||
"operating": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -1,62 +0,0 @@
|
||||
---
|
||||
sidebar_position: 10
|
||||
---
|
||||
|
||||
# Change chat owner
|
||||
Change chat owner
|
||||
|
||||
|
||||
|
||||
`Function ChangeChatOwner(Val URL, Val ChatID, Val UserID, Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| ChatID | --chat | String, Number | Chat ID |
|
||||
| UserID | --user | String, Number | User ID |
|
||||
| Token | --token | String | Access token, when app auth method used |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
|
||||
|
||||
<br/>
|
||||
|
||||
:::tip
|
||||
Method at API documentation: [im.chat.setOwner](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12111)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
ChatID = "1006";
|
||||
|
||||
UserID = 10;
|
||||
|
||||
Result = OPI_Bitrix24.ChangeChatOwner(URL, ChatID, UserID);
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
ChatID = "1008";
|
||||
|
||||
Result = OPI_Bitrix24.ChangeChatOwner(URL, ChatID, UserID, Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": true,
|
||||
"time": {
|
||||
"start": 1728454918.87876,
|
||||
"finish": 1728454918.91642,
|
||||
"duration": 0.0376641750335693,
|
||||
"processing": 0.0113739967346191,
|
||||
"date_start": "2024-10-09T09:21:58+03:00",
|
||||
"date_finish": "2024-10-09T09:21:58+03:00",
|
||||
"operating_reset_at": 1728455518,
|
||||
"operating": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -0,0 +1,65 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 10
|
||||
---
|
||||
|
||||
# Change chat owner
|
||||
Change chat owner
|
||||
|
||||
|
||||
|
||||
`Function ChangeChatOwner(Val URL, Val ChatID, Val UserID, Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| ChatID | --chat | String, Number | Chat ID |
|
||||
| UserID | --user | String, Number | User ID |
|
||||
| Token | --token | String | Access token, when app auth method used |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
|
||||
|
||||
<br/>
|
||||
|
||||
:::tip
|
||||
Method at API documentation: [im.chat.setOwner](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12111)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
ChatID = "1006";
|
||||
|
||||
UserID = 10;
|
||||
|
||||
Result = OPI_Bitrix24.ChangeChatOwner(URL, ChatID, UserID);
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
ChatID = "1008";
|
||||
|
||||
Result = OPI_Bitrix24.ChangeChatOwner(URL, ChatID, UserID, Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": true,
|
||||
"time": {
|
||||
"start": 1728454918.87876,
|
||||
"finish": 1728454918.91642,
|
||||
"duration": 0.0376641750335693,
|
||||
"processing": 0.0113739967346191,
|
||||
"date_start": "2024-10-09T09:21:58+03:00",
|
||||
"date_finish": "2024-10-09T09:21:58+03:00",
|
||||
"operating_reset_at": 1728455518,
|
||||
"operating": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -1,62 +0,0 @@
|
||||
---
|
||||
sidebar_position: 9
|
||||
---
|
||||
|
||||
# Change chat picture
|
||||
Setup new chat picture
|
||||
|
||||
|
||||
|
||||
`Function ChangeChatPicture(Val URL, Val ChatID, Val Image, Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| ChatID | --chat | String, Number | Chat ID |
|
||||
| Image | --picture | String, BinaryData | Picture data |
|
||||
| Token | --token | String | Access token, when app auth method used |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
|
||||
|
||||
<br/>
|
||||
|
||||
:::tip
|
||||
Method at API documentation: [im.chat.updateAvatar](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12109)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
ChatID = "1006";
|
||||
|
||||
Image = "https://api.athenaeum.digital/test_data/picture2.jpg";
|
||||
|
||||
Result = OPI_Bitrix24.ChangeChatPicture(URL, ChatID, Image);
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
ChatID = "1008";
|
||||
|
||||
Result = OPI_Bitrix24.ChangeChatPicture(URL, ChatID, Image, Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": true,
|
||||
"time": {
|
||||
"start": 1728454891.85277,
|
||||
"finish": 1728454893.18775,
|
||||
"duration": 1.33497500419617,
|
||||
"processing": 1.30738711357117,
|
||||
"date_start": "2024-10-09T09:21:31+03:00",
|
||||
"date_finish": "2024-10-09T09:21:33+03:00",
|
||||
"operating_reset_at": 1728455491,
|
||||
"operating": 1.30736899375916
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -0,0 +1,65 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 9
|
||||
---
|
||||
|
||||
# Change chat picture
|
||||
Setup new chat picture
|
||||
|
||||
|
||||
|
||||
`Function ChangeChatPicture(Val URL, Val ChatID, Val Image, Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| ChatID | --chat | String, Number | Chat ID |
|
||||
| Image | --picture | String, BinaryData | Picture data |
|
||||
| Token | --token | String | Access token, when app auth method used |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
|
||||
|
||||
<br/>
|
||||
|
||||
:::tip
|
||||
Method at API documentation: [im.chat.updateAvatar](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12109)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
ChatID = "1006";
|
||||
|
||||
Image = "https://api.athenaeum.digital/test_data/picture2.jpg";
|
||||
|
||||
Result = OPI_Bitrix24.ChangeChatPicture(URL, ChatID, Image);
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
ChatID = "1008";
|
||||
|
||||
Result = OPI_Bitrix24.ChangeChatPicture(URL, ChatID, Image, Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": true,
|
||||
"time": {
|
||||
"start": 1728454891.85277,
|
||||
"finish": 1728454893.18775,
|
||||
"duration": 1.33497500419617,
|
||||
"processing": 1.30738711357117,
|
||||
"date_start": "2024-10-09T09:21:31+03:00",
|
||||
"date_finish": "2024-10-09T09:21:33+03:00",
|
||||
"operating_reset_at": 1728455491,
|
||||
"operating": 1.30736899375916
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -1,64 +0,0 @@
|
||||
---
|
||||
sidebar_position: 7
|
||||
---
|
||||
|
||||
# Change chat title
|
||||
Change text of chat title
|
||||
|
||||
|
||||
|
||||
`Function ChangeChatTitle(Val URL, Val ChatID, Val Title, Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| ChatID | --chat | String, Number | Chat ID |
|
||||
| Title | --title | String | New title |
|
||||
| Token | --token | String | Access token, when app auth method used |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
|
||||
|
||||
<br/>
|
||||
|
||||
:::tip
|
||||
Method at API documentation: [im.chat.updateTitle](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12105)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
ChatID = "1006";
|
||||
|
||||
Title = "New chat title";
|
||||
|
||||
Result = OPI_Bitrix24.ChangeChatTitle(URL, ChatID, Title);
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
ChatID = "1008";
|
||||
|
||||
Title = "Another title";
|
||||
|
||||
Result = OPI_Bitrix24.ChangeChatTitle(URL, ChatID, Title, Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": true,
|
||||
"time": {
|
||||
"start": 1728454873.54688,
|
||||
"finish": 1728454873.62997,
|
||||
"duration": 0.0830919742584228,
|
||||
"processing": 0.0585200786590576,
|
||||
"date_start": "2024-10-09T09:21:13+03:00",
|
||||
"date_finish": "2024-10-09T09:21:13+03:00",
|
||||
"operating_reset_at": 1728455473,
|
||||
"operating": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -0,0 +1,67 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 7
|
||||
---
|
||||
|
||||
# Change chat title
|
||||
Change text of chat title
|
||||
|
||||
|
||||
|
||||
`Function ChangeChatTitle(Val URL, Val ChatID, Val Title, Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| ChatID | --chat | String, Number | Chat ID |
|
||||
| Title | --title | String | New title |
|
||||
| Token | --token | String | Access token, when app auth method used |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
|
||||
|
||||
<br/>
|
||||
|
||||
:::tip
|
||||
Method at API documentation: [im.chat.updateTitle](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12105)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
ChatID = "1006";
|
||||
|
||||
Title = "New chat title";
|
||||
|
||||
Result = OPI_Bitrix24.ChangeChatTitle(URL, ChatID, Title);
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
ChatID = "1008";
|
||||
|
||||
Title = "Another title";
|
||||
|
||||
Result = OPI_Bitrix24.ChangeChatTitle(URL, ChatID, Title, Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": true,
|
||||
"time": {
|
||||
"start": 1728454873.54688,
|
||||
"finish": 1728454873.62997,
|
||||
"duration": 0.0830919742584228,
|
||||
"processing": 0.0585200786590576,
|
||||
"date_start": "2024-10-09T09:21:13+03:00",
|
||||
"date_finish": "2024-10-09T09:21:13+03:00",
|
||||
"operating_reset_at": 1728455473,
|
||||
"operating": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -1,81 +0,0 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Create chat
|
||||
Creates a new chat based on the field structure
|
||||
|
||||
|
||||
|
||||
`Function CreateChat(Val URL, Val ChatStructure, Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| ChatStructure | --fields | Structure of KeyAndValue | Chat fields structure. See GetChatStructure |
|
||||
| Token | --token | String | Access token, when app auth method used |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
|
||||
|
||||
<br/>
|
||||
|
||||
:::tip
|
||||
Method at API documentation: [im.chat.add](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12093)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Image = "https://api.athenaeum.digital/test_data/picture.jpg";
|
||||
OPI_TypeConversion.GetBinaryData(Image);
|
||||
|
||||
B64Image = GetBase64StringFromBinaryData(Image);
|
||||
|
||||
MembersArray = New Array;
|
||||
MembersArray.Add(10);
|
||||
MembersArray.Add(1);
|
||||
|
||||
ChatStructure = New Structure;
|
||||
ChatStructure.Insert("TYPE" , "OPEN");
|
||||
ChatStructure.Insert("TITLE" , "New chat");
|
||||
ChatStructure.Insert("DESCRIPTION", "This is a new chat");
|
||||
ChatStructure.Insert("COLOR" , "GREEN");
|
||||
ChatStructure.Insert("MESSAGE" , "Welcome to new chat");
|
||||
ChatStructure.Insert("USERS" , MembersArray);
|
||||
ChatStructure.Insert("AVATAR" , B64Image);
|
||||
ChatStructure.Insert("OWNER_ID" , 1);
|
||||
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
|
||||
Result = OPI_Bitrix24.CreateChat(URL, ChatStructure);
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
|
||||
ChatStructure = New Structure;
|
||||
ChatStructure.Insert("TYPE" , "CHAT");
|
||||
ChatStructure.Insert("TITLE" , "Private chat");
|
||||
ChatStructure.Insert("USERS" , MembersArray);
|
||||
|
||||
Result = OPI_Bitrix24.CreateChat(URL, ChatStructure, Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": 988,
|
||||
"time": {
|
||||
"start": 1728454867.18514,
|
||||
"finish": 1728454867.47953,
|
||||
"duration": 0.294389009475708,
|
||||
"processing": 0.258857011795044,
|
||||
"date_start": "2024-10-09T09:21:07+03:00",
|
||||
"date_finish": "2024-10-09T09:21:07+03:00",
|
||||
"operating_reset_at": 1728455467,
|
||||
"operating": 0.258837938308716
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -0,0 +1,84 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Create chat
|
||||
Creates a new chat based on the field structure
|
||||
|
||||
|
||||
|
||||
`Function CreateChat(Val URL, Val ChatStructure, Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| ChatStructure | --fields | Structure of KeyAndValue | Chat fields structure. See GetChatStructure |
|
||||
| Token | --token | String | Access token, when app auth method used |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
|
||||
|
||||
<br/>
|
||||
|
||||
:::tip
|
||||
Method at API documentation: [im.chat.add](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12093)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Image = "https://api.athenaeum.digital/test_data/picture.jpg";
|
||||
OPI_TypeConversion.GetBinaryData(Image);
|
||||
|
||||
B64Image = GetBase64StringFromBinaryData(Image);
|
||||
|
||||
MembersArray = New Array;
|
||||
MembersArray.Add(10);
|
||||
MembersArray.Add(1);
|
||||
|
||||
ChatStructure = New Structure;
|
||||
ChatStructure.Insert("TYPE" , "OPEN");
|
||||
ChatStructure.Insert("TITLE" , "New chat");
|
||||
ChatStructure.Insert("DESCRIPTION", "This is a new chat");
|
||||
ChatStructure.Insert("COLOR" , "GREEN");
|
||||
ChatStructure.Insert("MESSAGE" , "Welcome to new chat");
|
||||
ChatStructure.Insert("USERS" , MembersArray);
|
||||
ChatStructure.Insert("AVATAR" , B64Image);
|
||||
ChatStructure.Insert("OWNER_ID" , 1);
|
||||
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
|
||||
Result = OPI_Bitrix24.CreateChat(URL, ChatStructure);
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
|
||||
ChatStructure = New Structure;
|
||||
ChatStructure.Insert("TYPE" , "CHAT");
|
||||
ChatStructure.Insert("TITLE" , "Private chat");
|
||||
ChatStructure.Insert("USERS" , MembersArray);
|
||||
|
||||
Result = OPI_Bitrix24.CreateChat(URL, ChatStructure, Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": 988,
|
||||
"time": {
|
||||
"start": 1728454867.18514,
|
||||
"finish": 1728454867.47953,
|
||||
"duration": 0.294389009475708,
|
||||
"processing": 0.258857011795044,
|
||||
"date_start": "2024-10-09T09:21:07+03:00",
|
||||
"date_finish": "2024-10-09T09:21:07+03:00",
|
||||
"operating_reset_at": 1728455467,
|
||||
"operating": 0.258837938308716
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -1,62 +0,0 @@
|
||||
---
|
||||
sidebar_position: 6
|
||||
---
|
||||
|
||||
# Delete user from chat
|
||||
Deletes user from chat
|
||||
|
||||
|
||||
|
||||
`Function DeleteUserFromChat(Val URL, Val ChatID, Val UserID, Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| ChatID | --chat | String, Number | Chat ID |
|
||||
| UserID | --user | String, Number | User ID |
|
||||
| Token | --token | String | Access token, when app auth method used |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
|
||||
|
||||
<br/>
|
||||
|
||||
:::tip
|
||||
Method at API documentation: [im.chat.user.delete](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12099)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
ChatID = "1006";
|
||||
|
||||
UserID = 10;
|
||||
|
||||
Result = OPI_Bitrix24.DeleteUserFromChat(URL, ChatID, UserID);
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
ChatID = "1008";
|
||||
|
||||
Result = OPI_Bitrix24.DeleteUserFromChat(URL, ChatID, UserID, Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": true,
|
||||
"time": {
|
||||
"start": 1728454872.91198,
|
||||
"finish": 1728454873.00982,
|
||||
"duration": 0.0978438854217529,
|
||||
"processing": 0.0658779144287109,
|
||||
"date_start": "2024-10-09T09:21:12+03:00",
|
||||
"date_finish": "2024-10-09T09:21:13+03:00",
|
||||
"operating_reset_at": 1728455472,
|
||||
"operating": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -0,0 +1,65 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 6
|
||||
---
|
||||
|
||||
# Delete user from chat
|
||||
Deletes user from chat
|
||||
|
||||
|
||||
|
||||
`Function DeleteUserFromChat(Val URL, Val ChatID, Val UserID, Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| ChatID | --chat | String, Number | Chat ID |
|
||||
| UserID | --user | String, Number | User ID |
|
||||
| Token | --token | String | Access token, when app auth method used |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
|
||||
|
||||
<br/>
|
||||
|
||||
:::tip
|
||||
Method at API documentation: [im.chat.user.delete](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12099)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
ChatID = "1006";
|
||||
|
||||
UserID = 10;
|
||||
|
||||
Result = OPI_Bitrix24.DeleteUserFromChat(URL, ChatID, UserID);
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
ChatID = "1008";
|
||||
|
||||
Result = OPI_Bitrix24.DeleteUserFromChat(URL, ChatID, UserID, Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": true,
|
||||
"time": {
|
||||
"start": 1728454872.91198,
|
||||
"finish": 1728454873.00982,
|
||||
"duration": 0.0978438854217529,
|
||||
"processing": 0.0658779144287109,
|
||||
"date_start": "2024-10-09T09:21:12+03:00",
|
||||
"date_finish": "2024-10-09T09:21:13+03:00",
|
||||
"operating_reset_at": 1728455472,
|
||||
"operating": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -1,59 +0,0 @@
|
||||
---
|
||||
sidebar_position: 11
|
||||
---
|
||||
|
||||
# Disable chat notifications
|
||||
Disable chat notifications
|
||||
|
||||
|
||||
|
||||
`Function DisableChatNotifications(Val URL, Val ChatID, Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| ChatID | --chat | String, Number | Chat ID |
|
||||
| Token | --token | String | Access token, when app auth method used |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
|
||||
|
||||
<br/>
|
||||
|
||||
:::tip
|
||||
Method at API documentation: [im.chat.mute](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=11473)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
ChatID = "1006";
|
||||
|
||||
Result = OPI_Bitrix24.DisableChatNotifications(URL, ChatID);
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
ChatID = "1008";
|
||||
|
||||
Result = OPI_Bitrix24.DisableChatNotifications(URL, ChatID, Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": true,
|
||||
"time": {
|
||||
"start": 1728454893.38864,
|
||||
"finish": 1728454893.44139,
|
||||
"duration": 0.0527479648590088,
|
||||
"processing": 0.0204250812530518,
|
||||
"date_start": "2024-10-09T09:21:33+03:00",
|
||||
"date_finish": "2024-10-09T09:21:33+03:00",
|
||||
"operating_reset_at": 1728455493,
|
||||
"operating": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -0,0 +1,62 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 11
|
||||
---
|
||||
|
||||
# Disable chat notifications
|
||||
Disable chat notifications
|
||||
|
||||
|
||||
|
||||
`Function DisableChatNotifications(Val URL, Val ChatID, Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| ChatID | --chat | String, Number | Chat ID |
|
||||
| Token | --token | String | Access token, when app auth method used |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
|
||||
|
||||
<br/>
|
||||
|
||||
:::tip
|
||||
Method at API documentation: [im.chat.mute](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=11473)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
ChatID = "1006";
|
||||
|
||||
Result = OPI_Bitrix24.DisableChatNotifications(URL, ChatID);
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
ChatID = "1008";
|
||||
|
||||
Result = OPI_Bitrix24.DisableChatNotifications(URL, ChatID, Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": true,
|
||||
"time": {
|
||||
"start": 1728454893.38864,
|
||||
"finish": 1728454893.44139,
|
||||
"duration": 0.0527479648590088,
|
||||
"processing": 0.0204250812530518,
|
||||
"date_start": "2024-10-09T09:21:33+03:00",
|
||||
"date_finish": "2024-10-09T09:21:33+03:00",
|
||||
"operating_reset_at": 1728455493,
|
||||
"operating": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -1,59 +0,0 @@
|
||||
---
|
||||
sidebar_position: 12
|
||||
---
|
||||
|
||||
# Enable chat notifications
|
||||
Enable chat notifications
|
||||
|
||||
|
||||
|
||||
`Function EnableChatNotifications(Val URL, Val ChatID, Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| ChatID | --chat | String, Number | Chat ID |
|
||||
| Token | --token | String | Access token, when app auth method used |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
|
||||
|
||||
<br/>
|
||||
|
||||
:::tip
|
||||
Method at API documentation: [im.chat.mute](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=11473)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
ChatID = "1006";
|
||||
|
||||
Result = OPI_Bitrix24.EnableChatNotifications(URL, ChatID);
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
ChatID = "1008";
|
||||
|
||||
Result = OPI_Bitrix24.EnableChatNotifications(URL, ChatID, Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": true,
|
||||
"time": {
|
||||
"start": 1728454893.58046,
|
||||
"finish": 1728454893.62361,
|
||||
"duration": 0.0431530475616455,
|
||||
"processing": 0.0164411067962646,
|
||||
"date_start": "2024-10-09T09:21:33+03:00",
|
||||
"date_finish": "2024-10-09T09:21:33+03:00",
|
||||
"operating_reset_at": 1728455493,
|
||||
"operating": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -0,0 +1,62 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 12
|
||||
---
|
||||
|
||||
# Enable chat notifications
|
||||
Enable chat notifications
|
||||
|
||||
|
||||
|
||||
`Function EnableChatNotifications(Val URL, Val ChatID, Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| ChatID | --chat | String, Number | Chat ID |
|
||||
| Token | --token | String | Access token, when app auth method used |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
|
||||
|
||||
<br/>
|
||||
|
||||
:::tip
|
||||
Method at API documentation: [im.chat.mute](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=11473)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
ChatID = "1006";
|
||||
|
||||
Result = OPI_Bitrix24.EnableChatNotifications(URL, ChatID);
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
ChatID = "1008";
|
||||
|
||||
Result = OPI_Bitrix24.EnableChatNotifications(URL, ChatID, Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": true,
|
||||
"time": {
|
||||
"start": 1728454893.58046,
|
||||
"finish": 1728454893.62361,
|
||||
"duration": 0.0431530475616455,
|
||||
"processing": 0.0164411067962646,
|
||||
"date_start": "2024-10-09T09:21:33+03:00",
|
||||
"date_finish": "2024-10-09T09:21:33+03:00",
|
||||
"operating_reset_at": 1728455493,
|
||||
"operating": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -1,61 +0,0 @@
|
||||
---
|
||||
sidebar_position: 20
|
||||
---
|
||||
|
||||
# Get chat files folder
|
||||
Get information about folder for chat files
|
||||
|
||||
|
||||
|
||||
`Function GetChatFilesFolder(Val URL, Val ChatID, Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| ChatID | --chat | String, Number | Chat ID |
|
||||
| Token | --token | String | Access token, when app auth method used |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
|
||||
|
||||
<br/>
|
||||
|
||||
:::tip
|
||||
Method at API documentation: [im.disk.folder.get](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11483)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
ChatID = "1006";
|
||||
|
||||
Result = OPI_Bitrix24.GetChatFilesFolder(URL, ChatID);
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
ChatID = "1008";
|
||||
|
||||
Result = OPI_Bitrix24.GetChatFilesFolder(URL, ChatID, Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": {
|
||||
"ID": 12610
|
||||
},
|
||||
"time": {
|
||||
"start": 1728454911.13738,
|
||||
"finish": 1728454911.19324,
|
||||
"duration": 0.0558590888977051,
|
||||
"processing": 0.0317718982696533,
|
||||
"date_start": "2024-10-09T09:21:51+03:00",
|
||||
"date_finish": "2024-10-09T09:21:51+03:00",
|
||||
"operating_reset_at": 1728455511,
|
||||
"operating": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -0,0 +1,64 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 20
|
||||
---
|
||||
|
||||
# Get chat files folder
|
||||
Get information about folder for chat files
|
||||
|
||||
|
||||
|
||||
`Function GetChatFilesFolder(Val URL, Val ChatID, Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| ChatID | --chat | String, Number | Chat ID |
|
||||
| Token | --token | String | Access token, when app auth method used |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
|
||||
|
||||
<br/>
|
||||
|
||||
:::tip
|
||||
Method at API documentation: [im.disk.folder.get](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11483)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
ChatID = "1006";
|
||||
|
||||
Result = OPI_Bitrix24.GetChatFilesFolder(URL, ChatID);
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
ChatID = "1008";
|
||||
|
||||
Result = OPI_Bitrix24.GetChatFilesFolder(URL, ChatID, Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": {
|
||||
"ID": 12610
|
||||
},
|
||||
"time": {
|
||||
"start": 1728454911.13738,
|
||||
"finish": 1728454911.19324,
|
||||
"duration": 0.0558590888977051,
|
||||
"processing": 0.0317718982696533,
|
||||
"date_start": "2024-10-09T09:21:51+03:00",
|
||||
"date_finish": "2024-10-09T09:21:51+03:00",
|
||||
"operating_reset_at": 1728455511,
|
||||
"operating": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -1,117 +0,0 @@
|
||||
---
|
||||
sidebar_position: 15
|
||||
---
|
||||
|
||||
# Get chat members list
|
||||
Get chat members list
|
||||
|
||||
|
||||
|
||||
`Function GetChatMembersList(Val URL, Val ChatID, Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) |
|
||||
| Token | --token | String | Access token, when app auth method used |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
|
||||
|
||||
<br/>
|
||||
|
||||
:::tip
|
||||
Method at API documentation: [im.dialog.users.list](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=23800)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
ChatID = "chat" + "1006";
|
||||
|
||||
Result = OPI_Bitrix24.GetChatMembersList(URL, ChatID);
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
UserID = 10;
|
||||
|
||||
Result = OPI_Bitrix24.GetChatMembersList(URL, UserID, Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": [
|
||||
{
|
||||
"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-13T21:36:23+03:00",
|
||||
"mobile_last_date": false,
|
||||
"absent": false,
|
||||
"departments": [
|
||||
1,
|
||||
264
|
||||
],
|
||||
"phones": false,
|
||||
"bot_data": null
|
||||
},
|
||||
{
|
||||
"id": 1,
|
||||
"active": true,
|
||||
"name": "Антон Титовец",
|
||||
"first_name": "Антон",
|
||||
"last_name": "Титовец",
|
||||
"work_position": null,
|
||||
"color": "#df532d",
|
||||
"avatar": "https://cdn-ru.bitrix24.by/b28528874/resize_cache/30/ff58db95aecdfa09ae61b51b5fd8f63f/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg",
|
||||
"gender": "M",
|
||||
"birthday": "",
|
||||
"extranet": false,
|
||||
"network": false,
|
||||
"bot": false,
|
||||
"connector": false,
|
||||
"external_auth_id": "socservices",
|
||||
"status": "online",
|
||||
"idle": false,
|
||||
"last_activity_date": "2024-09-17T21:21:49+03:00",
|
||||
"mobile_last_date": false,
|
||||
"absent": false,
|
||||
"departments": [
|
||||
1,
|
||||
264
|
||||
],
|
||||
"phones": false,
|
||||
"bot_data": null
|
||||
}
|
||||
],
|
||||
"total": 2,
|
||||
"time": {
|
||||
"start": 1728454904.75088,
|
||||
"finish": 1728454904.78679,
|
||||
"duration": 0.0359148979187012,
|
||||
"processing": 0.00780296325683594,
|
||||
"date_start": "2024-10-09T09:21:44+03:00",
|
||||
"date_finish": "2024-10-09T09:21:44+03:00",
|
||||
"operating_reset_at": 1728455504,
|
||||
"operating": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -0,0 +1,120 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 15
|
||||
---
|
||||
|
||||
# Get chat members list
|
||||
Get chat members list
|
||||
|
||||
|
||||
|
||||
`Function GetChatMembersList(Val URL, Val ChatID, Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) |
|
||||
| Token | --token | String | Access token, when app auth method used |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
|
||||
|
||||
<br/>
|
||||
|
||||
:::tip
|
||||
Method at API documentation: [im.dialog.users.list](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=23800)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
ChatID = "chat" + "1006";
|
||||
|
||||
Result = OPI_Bitrix24.GetChatMembersList(URL, ChatID);
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
UserID = 10;
|
||||
|
||||
Result = OPI_Bitrix24.GetChatMembersList(URL, UserID, Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": [
|
||||
{
|
||||
"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-13T21:36:23+03:00",
|
||||
"mobile_last_date": false,
|
||||
"absent": false,
|
||||
"departments": [
|
||||
1,
|
||||
264
|
||||
],
|
||||
"phones": false,
|
||||
"bot_data": null
|
||||
},
|
||||
{
|
||||
"id": 1,
|
||||
"active": true,
|
||||
"name": "Антон Титовец",
|
||||
"first_name": "Антон",
|
||||
"last_name": "Титовец",
|
||||
"work_position": null,
|
||||
"color": "#df532d",
|
||||
"avatar": "https://cdn-ru.bitrix24.by/b28528874/resize_cache/30/ff58db95aecdfa09ae61b51b5fd8f63f/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg",
|
||||
"gender": "M",
|
||||
"birthday": "",
|
||||
"extranet": false,
|
||||
"network": false,
|
||||
"bot": false,
|
||||
"connector": false,
|
||||
"external_auth_id": "socservices",
|
||||
"status": "online",
|
||||
"idle": false,
|
||||
"last_activity_date": "2024-09-17T21:21:49+03:00",
|
||||
"mobile_last_date": false,
|
||||
"absent": false,
|
||||
"departments": [
|
||||
1,
|
||||
264
|
||||
],
|
||||
"phones": false,
|
||||
"bot_data": null
|
||||
}
|
||||
],
|
||||
"total": 2,
|
||||
"time": {
|
||||
"start": 1728454904.75088,
|
||||
"finish": 1728454904.78679,
|
||||
"duration": 0.0359148979187012,
|
||||
"processing": 0.00780296325683594,
|
||||
"date_start": "2024-10-09T09:21:44+03:00",
|
||||
"date_finish": "2024-10-09T09:21:44+03:00",
|
||||
"operating_reset_at": 1728455504,
|
||||
"operating": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -1,199 +0,0 @@
|
||||
---
|
||||
sidebar_position: 13
|
||||
---
|
||||
|
||||
# Get chat messages list
|
||||
Gets a list of 20 chat or dialog messages, depending on the FirstID and LastID specified
|
||||
|
||||
|
||||
|
||||
`Function GetChatMessagesList(Val URL, Val ChatID, Val LastID = "", Val FirstID = "", Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) |
|
||||
| LastID | --last | String, Number | Id of last message |
|
||||
| FirstID | --first | String, Number | ID of first message |
|
||||
| Token | --token | String | Access token, when app auth method used |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
|
||||
|
||||
<br/>
|
||||
|
||||
:::tip
|
||||
Method at API documentation: [im.dialog.messages.get](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=11479)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
ChatID = "chat4";
|
||||
|
||||
Result = OPI_Bitrix24.GetChatMessagesList(URL, ChatID);
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
UserID = 10;
|
||||
|
||||
Result = OPI_Bitrix24.GetChatMessagesList(URL, UserID, , 0, Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": {
|
||||
"chat_id": 10,
|
||||
"messages": [
|
||||
{
|
||||
"id": 16,
|
||||
"chat_id": 10,
|
||||
"author_id": 0,
|
||||
"date": "2024-06-15T19:48:49+03:00",
|
||||
"text": "Я с вами в команде!",
|
||||
"unread": false,
|
||||
"uuid": null,
|
||||
"replaces": [],
|
||||
"params": {
|
||||
"CODE": [
|
||||
"USER_JOIN"
|
||||
]
|
||||
},
|
||||
"disappearing_date": null
|
||||
},
|
||||
{
|
||||
"id": 3808,
|
||||
"chat_id": 10,
|
||||
"author_id": 1,
|
||||
"date": "2024-07-13T17:45:29+03:00",
|
||||
"text": "Сообщение для теста",
|
||||
"unread": false,
|
||||
"uuid": null,
|
||||
"replaces": [],
|
||||
"params": [],
|
||||
"disappearing_date": null
|
||||
},
|
||||
{
|
||||
"id": 3810,
|
||||
"chat_id": 10,
|
||||
"author_id": 10,
|
||||
"date": "2024-07-13T17:46:31+03:00",
|
||||
"text": "Понял",
|
||||
"unread": false,
|
||||
"uuid": null,
|
||||
"replaces": [],
|
||||
"params": [],
|
||||
"disappearing_date": null
|
||||
},
|
||||
{
|
||||
"id": 3852,
|
||||
"chat_id": 10,
|
||||
"author_id": 10,
|
||||
"date": "2024-07-13T17:54:42+03:00",
|
||||
"text": "Принял",
|
||||
"unread": false,
|
||||
"uuid": null,
|
||||
"replaces": [],
|
||||
"params": [],
|
||||
"disappearing_date": null
|
||||
},
|
||||
{
|
||||
"id": 3854,
|
||||
"chat_id": 10,
|
||||
"author_id": 10,
|
||||
"date": "2024-07-13T17:54:43+03:00",
|
||||
"text": "Записал",
|
||||
"unread": false,
|
||||
"uuid": null,
|
||||
"replaces": [],
|
||||
"params": [],
|
||||
"disappearing_date": null
|
||||
},
|
||||
{
|
||||
"id": 4286,
|
||||
"chat_id": 10,
|
||||
"author_id": 1,
|
||||
"date": "2024-07-13T19:06:51+03:00",
|
||||
"text": "Текст сообщения",
|
||||
"unread": false,
|
||||
"uuid": null,
|
||||
"replaces": [],
|
||||
"params": [],
|
||||
"disappearing_date": null
|
||||
},
|
||||
{
|
||||
"id": 4366,
|
||||
"chat_id": 10,
|
||||
"author_id": 1,
|
||||
"date": "2024-07-13T19:40:58+03:00",
|
||||
"text": "Message text",
|
||||
"unread": false,
|
||||
"uuid": null,
|
||||
"replaces": [],
|
||||
"params": [],
|
||||
"disappearing_date": null
|
||||
},
|
||||
{
|
||||
"id": 4406,
|
||||
"chat_id": 10,
|
||||
"author_id": 1,
|
||||
"date": "2024-07-13T22:57:33+03:00",
|
||||
"text": "Это сообщение было удалено",
|
||||
"unread": false,
|
||||
"uuid": null,
|
||||
"replaces": [],
|
||||
"params": {
|
||||
"IS_DELETED": "Y"
|
||||
},
|
||||
"disappearing_date": null
|
||||
},
|
||||
{
|
||||
"id": 4446,
|
||||
"chat_id": 10,
|
||||
"author_id": 1,
|
||||
"date": "2024-07-13T23:21:27+03:00",
|
||||
"text": "Текст сообщения",
|
||||
"unread": false,
|
||||
"uuid": null,
|
||||
"replaces": [],
|
||||
"params": [],
|
||||
"disappearing_date": null
|
||||
},
|
||||
{
|
||||
"id": 4486,
|
||||
"chat_id": 10,
|
||||
"author_id": 1,
|
||||
"date": "2024-07-13T23:22:30+03:00",
|
||||
"text": "Это сообщение было удалено",
|
||||
"unread": false,
|
||||
"uuid": null,
|
||||
"replaces": [],
|
||||
"params": {
|
||||
"IS_DELETED": "Y"
|
||||
},
|
||||
"disappearing_date": null
|
||||
},
|
||||
{
|
||||
"id": 4526,
|
||||
"chat_id": 10,
|
||||
"author_id": 1,
|
||||
"date": "2024-07-13T23:41:21+03:00",
|
||||
"text": "Это сообщение было удалено",
|
||||
"unread": false,
|
||||
"uuid": null,
|
||||
"replaces": [],
|
||||
"params": {
|
||||
"IS_DELETED": "Y"
|
||||
},
|
||||
"disappearing_date": null
|
||||
},
|
||||
{
|
||||
"id": 4668,
|
||||
"chat_id": 10,
|
||||
"author_id": 1,
|
||||
...
|
||||
```
|
||||
@ -0,0 +1,202 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 13
|
||||
---
|
||||
|
||||
# Get chat messages list
|
||||
Gets a list of 20 chat or dialog messages, depending on the FirstID and LastID specified
|
||||
|
||||
|
||||
|
||||
`Function GetChatMessagesList(Val URL, Val ChatID, Val LastID = "", Val FirstID = "", Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) |
|
||||
| LastID | --last | String, Number | Id of last message |
|
||||
| FirstID | --first | String, Number | ID of first message |
|
||||
| Token | --token | String | Access token, when app auth method used |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
|
||||
|
||||
<br/>
|
||||
|
||||
:::tip
|
||||
Method at API documentation: [im.dialog.messages.get](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=11479)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
ChatID = "chat4";
|
||||
|
||||
Result = OPI_Bitrix24.GetChatMessagesList(URL, ChatID);
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
UserID = 10;
|
||||
|
||||
Result = OPI_Bitrix24.GetChatMessagesList(URL, UserID, , 0, Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": {
|
||||
"chat_id": 10,
|
||||
"messages": [
|
||||
{
|
||||
"id": 16,
|
||||
"chat_id": 10,
|
||||
"author_id": 0,
|
||||
"date": "2024-06-15T19:48:49+03:00",
|
||||
"text": "Я с вами в команде!",
|
||||
"unread": false,
|
||||
"uuid": null,
|
||||
"replaces": [],
|
||||
"params": {
|
||||
"CODE": [
|
||||
"USER_JOIN"
|
||||
]
|
||||
},
|
||||
"disappearing_date": null
|
||||
},
|
||||
{
|
||||
"id": 3808,
|
||||
"chat_id": 10,
|
||||
"author_id": 1,
|
||||
"date": "2024-07-13T17:45:29+03:00",
|
||||
"text": "Сообщение для теста",
|
||||
"unread": false,
|
||||
"uuid": null,
|
||||
"replaces": [],
|
||||
"params": [],
|
||||
"disappearing_date": null
|
||||
},
|
||||
{
|
||||
"id": 3810,
|
||||
"chat_id": 10,
|
||||
"author_id": 10,
|
||||
"date": "2024-07-13T17:46:31+03:00",
|
||||
"text": "Понял",
|
||||
"unread": false,
|
||||
"uuid": null,
|
||||
"replaces": [],
|
||||
"params": [],
|
||||
"disappearing_date": null
|
||||
},
|
||||
{
|
||||
"id": 3852,
|
||||
"chat_id": 10,
|
||||
"author_id": 10,
|
||||
"date": "2024-07-13T17:54:42+03:00",
|
||||
"text": "Принял",
|
||||
"unread": false,
|
||||
"uuid": null,
|
||||
"replaces": [],
|
||||
"params": [],
|
||||
"disappearing_date": null
|
||||
},
|
||||
{
|
||||
"id": 3854,
|
||||
"chat_id": 10,
|
||||
"author_id": 10,
|
||||
"date": "2024-07-13T17:54:43+03:00",
|
||||
"text": "Записал",
|
||||
"unread": false,
|
||||
"uuid": null,
|
||||
"replaces": [],
|
||||
"params": [],
|
||||
"disappearing_date": null
|
||||
},
|
||||
{
|
||||
"id": 4286,
|
||||
"chat_id": 10,
|
||||
"author_id": 1,
|
||||
"date": "2024-07-13T19:06:51+03:00",
|
||||
"text": "Текст сообщения",
|
||||
"unread": false,
|
||||
"uuid": null,
|
||||
"replaces": [],
|
||||
"params": [],
|
||||
"disappearing_date": null
|
||||
},
|
||||
{
|
||||
"id": 4366,
|
||||
"chat_id": 10,
|
||||
"author_id": 1,
|
||||
"date": "2024-07-13T19:40:58+03:00",
|
||||
"text": "Message text",
|
||||
"unread": false,
|
||||
"uuid": null,
|
||||
"replaces": [],
|
||||
"params": [],
|
||||
"disappearing_date": null
|
||||
},
|
||||
{
|
||||
"id": 4406,
|
||||
"chat_id": 10,
|
||||
"author_id": 1,
|
||||
"date": "2024-07-13T22:57:33+03:00",
|
||||
"text": "Это сообщение было удалено",
|
||||
"unread": false,
|
||||
"uuid": null,
|
||||
"replaces": [],
|
||||
"params": {
|
||||
"IS_DELETED": "Y"
|
||||
},
|
||||
"disappearing_date": null
|
||||
},
|
||||
{
|
||||
"id": 4446,
|
||||
"chat_id": 10,
|
||||
"author_id": 1,
|
||||
"date": "2024-07-13T23:21:27+03:00",
|
||||
"text": "Текст сообщения",
|
||||
"unread": false,
|
||||
"uuid": null,
|
||||
"replaces": [],
|
||||
"params": [],
|
||||
"disappearing_date": null
|
||||
},
|
||||
{
|
||||
"id": 4486,
|
||||
"chat_id": 10,
|
||||
"author_id": 1,
|
||||
"date": "2024-07-13T23:22:30+03:00",
|
||||
"text": "Это сообщение было удалено",
|
||||
"unread": false,
|
||||
"uuid": null,
|
||||
"replaces": [],
|
||||
"params": {
|
||||
"IS_DELETED": "Y"
|
||||
},
|
||||
"disappearing_date": null
|
||||
},
|
||||
{
|
||||
"id": 4526,
|
||||
"chat_id": 10,
|
||||
"author_id": 1,
|
||||
"date": "2024-07-13T23:41:21+03:00",
|
||||
"text": "Это сообщение было удалено",
|
||||
"unread": false,
|
||||
"uuid": null,
|
||||
"replaces": [],
|
||||
"params": {
|
||||
"IS_DELETED": "Y"
|
||||
},
|
||||
"disappearing_date": null
|
||||
},
|
||||
{
|
||||
"id": 4668,
|
||||
"chat_id": 10,
|
||||
"author_id": 1,
|
||||
...
|
||||
```
|
||||
@ -1,42 +0,0 @@
|
||||
---
|
||||
sidebar_position: 21
|
||||
---
|
||||
|
||||
# Get chats structure
|
||||
Get chat fields structure
|
||||
|
||||
|
||||
|
||||
`Function GetChatStructure(Val Clear = False) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Clear | --empty | Boolean | True > structure with empty values, False > field types at values |
|
||||
|
||||
|
||||
Returns: Structure of KeyAndValue - Fields structure
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Result = OPI_Bitrix24.GetChatStructure();
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"TYPE": "<Chat type OPEN (Public) | CHAT (Private)>",
|
||||
"TITLE": "<Chat title>",
|
||||
"DESCRIPTION": "<Chat description>",
|
||||
"COLOR": "<Chat color: RED, GREEN, MINT, LIGHT_BLUE, DARK_BLUE, PURPLE, AQUA, ...>",
|
||||
"MESSAGE": "<First chat message>",
|
||||
"USERS": "<Chat members array>",
|
||||
"AVATAR": "<Base64 chat picture>",
|
||||
"OWNER_ID": "<ID of chat owner. Current user by default>"
|
||||
}
|
||||
```
|
||||
@ -0,0 +1,45 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 21
|
||||
---
|
||||
|
||||
# Get chats structure
|
||||
Get chat fields structure
|
||||
|
||||
|
||||
|
||||
`Function GetChatStructure(Val Clear = False) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| Clear | --empty | Boolean | True > structure with empty values, False > field types at values |
|
||||
|
||||
|
||||
Returns: Structure of KeyAndValue - Fields structure
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
Result = OPI_Bitrix24.GetChatStructure();
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"TYPE": "<Chat type OPEN (Public) | CHAT (Private)>",
|
||||
"TITLE": "<Chat title>",
|
||||
"DESCRIPTION": "<Chat description>",
|
||||
"COLOR": "<Chat color: RED, GREEN, MINT, LIGHT_BLUE, DARK_BLUE, PURPLE, AQUA, ...>",
|
||||
"MESSAGE": "<First chat message>",
|
||||
"USERS": "<Chat members array>",
|
||||
"AVATAR": "<Base64 chat picture>",
|
||||
"OWNER_ID": "<ID of chat owner. Current user by default>"
|
||||
}
|
||||
```
|
||||
@ -1,62 +0,0 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Get chats users
|
||||
Gets the list of chat users by ID
|
||||
|
||||
|
||||
|
||||
`Function GetChatUsers(Val URL, Val ChatID, Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| ChatID | --chat | String, Number | Chat ID |
|
||||
| Token | --token | String | Access token, when app auth method used |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
|
||||
|
||||
<br/>
|
||||
|
||||
:::tip
|
||||
Method at API documentation: [im.chat.user.list](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12095)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
ChatID = "1006";
|
||||
|
||||
Result = OPI_Bitrix24.GetChatUsers(URL, ChatID);
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
ChatID = "1008";
|
||||
|
||||
Result = OPI_Bitrix24.GetChatUsers(URL, ChatID, Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": [
|
||||
1,
|
||||
10
|
||||
],
|
||||
"time": {
|
||||
"start": 1728454872.6475,
|
||||
"finish": 1728454872.68151,
|
||||
"duration": 0.0340070724487305,
|
||||
"processing": 0.00371289253234863,
|
||||
"date_start": "2024-10-09T09:21:12+03:00",
|
||||
"date_finish": "2024-10-09T09:21:12+03:00",
|
||||
"operating_reset_at": 1728455472,
|
||||
"operating": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -0,0 +1,65 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Get chats users
|
||||
Gets the list of chat users by ID
|
||||
|
||||
|
||||
|
||||
`Function GetChatUsers(Val URL, Val ChatID, Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| ChatID | --chat | String, Number | Chat ID |
|
||||
| Token | --token | String | Access token, when app auth method used |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
|
||||
|
||||
<br/>
|
||||
|
||||
:::tip
|
||||
Method at API documentation: [im.chat.user.list](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12095)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
ChatID = "1006";
|
||||
|
||||
Result = OPI_Bitrix24.GetChatUsers(URL, ChatID);
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
ChatID = "1008";
|
||||
|
||||
Result = OPI_Bitrix24.GetChatUsers(URL, ChatID, Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": [
|
||||
1,
|
||||
10
|
||||
],
|
||||
"time": {
|
||||
"start": 1728454872.6475,
|
||||
"finish": 1728454872.68151,
|
||||
"duration": 0.0340070724487305,
|
||||
"processing": 0.00371289253234863,
|
||||
"date_start": "2024-10-09T09:21:12+03:00",
|
||||
"date_finish": "2024-10-09T09:21:12+03:00",
|
||||
"operating_reset_at": 1728455472,
|
||||
"operating": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -1,128 +0,0 @@
|
||||
---
|
||||
sidebar_position: 14
|
||||
---
|
||||
|
||||
# Get dialog
|
||||
Get chat data by ID
|
||||
|
||||
|
||||
|
||||
`Function GetDialog(Val URL, Val ChatID, Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) |
|
||||
| Token | --token | String | Access token, when app auth method used |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
|
||||
|
||||
<br/>
|
||||
|
||||
:::tip
|
||||
Method at API documentation: [im.dialog.get](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12886)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
ChatID = "chat" + "1006";
|
||||
|
||||
Result = OPI_Bitrix24.GetDialog(URL, ChatID);
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
UserID = 10;
|
||||
|
||||
Result = OPI_Bitrix24.GetDialog(URL, UserID, Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": {
|
||||
"id": 10,
|
||||
"parent_chat_id": 0,
|
||||
"parent_message_id": 0,
|
||||
"name": "",
|
||||
"description": "",
|
||||
"owner": 10,
|
||||
"extranet": false,
|
||||
"avatar": "",
|
||||
"color": "#ab7761",
|
||||
"type": "private",
|
||||
"counter": 4,
|
||||
"user_counter": 0,
|
||||
"message_count": 187,
|
||||
"unread_id": 16,
|
||||
"restrictions": {
|
||||
"avatar": true,
|
||||
"rename": true,
|
||||
"extend": true,
|
||||
"call": true,
|
||||
"mute": true,
|
||||
"leave": true,
|
||||
"leave_owner": true,
|
||||
"send": true,
|
||||
"user_list": true
|
||||
},
|
||||
"last_message_id": 17682,
|
||||
"last_id": 0,
|
||||
"marked_id": 0,
|
||||
"disk_folder_id": 0,
|
||||
"entity_type": "",
|
||||
"entity_id": "",
|
||||
"entity_data_1": "",
|
||||
"entity_data_2": "",
|
||||
"entity_data_3": "",
|
||||
"mute_list": [],
|
||||
"date_create": "2024-06-15T19:48:49+03:00",
|
||||
"message_type": "P",
|
||||
"disappearing_time": 0,
|
||||
"public": "",
|
||||
"role": "member",
|
||||
"entity_link": {
|
||||
"type": "",
|
||||
"url": ""
|
||||
},
|
||||
"permissions": {
|
||||
"manage_users_add": "member",
|
||||
"manage_users_delete": "manager",
|
||||
"manage_ui": "member",
|
||||
"manage_settings": "owner",
|
||||
"manage_messages": "member",
|
||||
"can_post": "member"
|
||||
},
|
||||
"is_new": false,
|
||||
"readed_list": [
|
||||
{
|
||||
"user_id": 10,
|
||||
"user_name": "Techno Pizza",
|
||||
"message_id": 3854,
|
||||
"date": null
|
||||
}
|
||||
],
|
||||
"manager_list": [],
|
||||
"last_message_views": {
|
||||
"message_id": 17682,
|
||||
"first_viewers": [],
|
||||
"count_of_viewers": 0
|
||||
},
|
||||
"dialog_id": "10"
|
||||
},
|
||||
"time": {
|
||||
"start": 1728454899.5196,
|
||||
"finish": 1728454899.56299,
|
||||
"duration": 0.0433859825134277,
|
||||
"processing": 0.0178430080413818,
|
||||
"date_start": "2024-10-09T09:21:39+03:00",
|
||||
"date_finish": "2024-10-09T09:21:39+03:00",
|
||||
"operating_reset_at": 1728455499,
|
||||
"operating": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
131
docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-dialog.mdx
Normal file
131
docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-dialog.mdx
Normal file
@ -0,0 +1,131 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
sidebar_position: 14
|
||||
---
|
||||
|
||||
# Get dialog
|
||||
Get chat data by ID
|
||||
|
||||
|
||||
|
||||
`Function GetDialog(Val URL, Val ChatID, Val Token = "") Export`
|
||||
|
||||
| Parameter | CLI option | Type | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) |
|
||||
| Token | --token | String | Access token, when app auth method used |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
|
||||
|
||||
<br/>
|
||||
|
||||
:::tip
|
||||
Method at API documentation: [im.dialog.get](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12886)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
ChatID = "chat" + "1006";
|
||||
|
||||
Result = OPI_Bitrix24.GetDialog(URL, ChatID);
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
UserID = 10;
|
||||
|
||||
Result = OPI_Bitrix24.GetDialog(URL, UserID, Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": {
|
||||
"id": 10,
|
||||
"parent_chat_id": 0,
|
||||
"parent_message_id": 0,
|
||||
"name": "",
|
||||
"description": "",
|
||||
"owner": 10,
|
||||
"extranet": false,
|
||||
"avatar": "",
|
||||
"color": "#ab7761",
|
||||
"type": "private",
|
||||
"counter": 4,
|
||||
"user_counter": 0,
|
||||
"message_count": 187,
|
||||
"unread_id": 16,
|
||||
"restrictions": {
|
||||
"avatar": true,
|
||||
"rename": true,
|
||||
"extend": true,
|
||||
"call": true,
|
||||
"mute": true,
|
||||
"leave": true,
|
||||
"leave_owner": true,
|
||||
"send": true,
|
||||
"user_list": true
|
||||
},
|
||||
"last_message_id": 17682,
|
||||
"last_id": 0,
|
||||
"marked_id": 0,
|
||||
"disk_folder_id": 0,
|
||||
"entity_type": "",
|
||||
"entity_id": "",
|
||||
"entity_data_1": "",
|
||||
"entity_data_2": "",
|
||||
"entity_data_3": "",
|
||||
"mute_list": [],
|
||||
"date_create": "2024-06-15T19:48:49+03:00",
|
||||
"message_type": "P",
|
||||
"disappearing_time": 0,
|
||||
"public": "",
|
||||
"role": "member",
|
||||
"entity_link": {
|
||||
"type": "",
|
||||
"url": ""
|
||||
},
|
||||
"permissions": {
|
||||
"manage_users_add": "member",
|
||||
"manage_users_delete": "manager",
|
||||
"manage_ui": "member",
|
||||
"manage_settings": "owner",
|
||||
"manage_messages": "member",
|
||||
"can_post": "member"
|
||||
},
|
||||
"is_new": false,
|
||||
"readed_list": [
|
||||
{
|
||||
"user_id": 10,
|
||||
"user_name": "Techno Pizza",
|
||||
"message_id": 3854,
|
||||
"date": null
|
||||
}
|
||||
],
|
||||
"manager_list": [],
|
||||
"last_message_views": {
|
||||
"message_id": 17682,
|
||||
"first_viewers": [],
|
||||
"count_of_viewers": 0
|
||||
},
|
||||
"dialog_id": "10"
|
||||
},
|
||||
"time": {
|
||||
"start": 1728454899.5196,
|
||||
"finish": 1728454899.56299,
|
||||
"duration": 0.0433859825134277,
|
||||
"processing": 0.0178430080413818,
|
||||
"date_start": "2024-10-09T09:21:39+03:00",
|
||||
"date_finish": "2024-10-09T09:21:39+03:00",
|
||||
"operating_reset_at": 1728455499,
|
||||
"operating": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -1,56 +0,0 @@
|
||||
---
|
||||
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 | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| Token | --token | String | Access token, when app auth method used |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
|
||||
|
||||
<br/>
|
||||
|
||||
:::tip
|
||||
Method at API documentation: [im.user.status.get](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11497)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
|
||||
Result = OPI_Bitrix24.GetUserStatus(URL);
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
|
||||
Result = OPI_Bitrix24.GetUserStatus(URL, Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": "away",
|
||||
"time": {
|
||||
"start": 1728454841.43872,
|
||||
"finish": 1728454841.46354,
|
||||
"duration": 0.0248241424560547,
|
||||
"processing": 0.000161886215209961,
|
||||
"date_start": "2024-10-09T09:20:41+03:00",
|
||||
"date_finish": "2024-10-09T09:20:41+03:00",
|
||||
"operating_reset_at": 1728455441,
|
||||
"operating": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -0,0 +1,59 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
---
|
||||
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 | Description |
|
||||
|-|-|-|-|
|
||||
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
|
||||
| Token | --token | String | Access token, when app auth method used |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
|
||||
|
||||
<br/>
|
||||
|
||||
:::tip
|
||||
Method at API documentation: [im.user.status.get](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11497)
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
```bsl title="Code example"
|
||||
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
||||
|
||||
Result = OPI_Bitrix24.GetUserStatus(URL);
|
||||
|
||||
URL = "b24-ar17wx.bitrix24.by";
|
||||
Token = "21750a67006e9f06006b12e400000001000...";
|
||||
|
||||
Result = OPI_Bitrix24.GetUserStatus(URL, Token);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
```json title="Result"
|
||||
{
|
||||
"result": "away",
|
||||
"time": {
|
||||
"start": 1728454841.43872,
|
||||
"finish": 1728454841.46354,
|
||||
"duration": 0.0248241424560547,
|
||||
"processing": 0.000161886215209961,
|
||||
"date_start": "2024-10-09T09:20:41+03:00",
|
||||
"date_finish": "2024-10-09T09:20:41+03:00",
|
||||
"operating_reset_at": 1728455441,
|
||||
"operating": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user