1c/OpenIntegrations
1
0
Fork 0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2025-12-01 22:29:52 +02:00
Code Issues Releases Activity

Создание MD файлов документации

Browse Source
This commit is contained in:
Vitaly the Alpaca
2024-06-07 11:53:24 +00:00
committed by Vitaly the Alpaca (bot)
parent d84469da0e
commit bf088ac606
159 changed files with 6660 additions and 6660 deletions
Download Patch File Download Diff File Expand all files Collapse all files

172
docs/en/md/Airtable/Working-with-databases/Create-database.md
View File

@@ -1,86 +1,86 @@
---
sidebar_position: 3
---
# Create base
Creates a new database
*Function CreateDatabase(Val Token, Val Workspace, Val Name, Val TableCollection) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| 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
```bsl title="Code example"
Workspace = "wspdf8yl1yZz3PmWZ";
Name = "TestDatabase";
FieldArray = New Array;
FieldArray.Add(OPI_Airtable.GetNumberField("Number"));
FieldArray.Add(OPI_Airtable.GetStringField("String"));
TableName = "TestTable";
TableCollection = New Map;
TableCollection.Insert(TableName, FieldArray);
Response = OPI_Airtable.CreateDatabase(Token, Workspace, Name, TableCollection); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
```
```sh title="CLI command example"
oint airtable CreateDatabase --token %token% --ws "wspdf8yl1yZz3PmWZ" --title "TestDatabase" --tablesdata %tablesdata%
```
```json title="Result"
{
"id": "applEsyJmBRm12AuN",
"tables": [
{
"id": "tblqZzW78Rvsdt9gt",
"name": "TestTable",
"primaryFieldId": "fldj9Z3fEpLzv40d0",
"fields": [
{
"type": "number",
"options": {
"precision": 0
},
"id": "fldj9Z3fEpLzv40d0",
"name": "Number"
},
{
"type": "richText",
"id": "fldX1kR7lienmcdEj",
"name": "String"
}
],
"views": [
{
"id": "viwbKE3PS9jl6bqJl",
"name": "Grid view",
"type": "grid"
}
]
}
]
}
```
---
sidebar_position: 3
---
# Create base
Creates a new database
*Function CreateDatabase(Val Token, Val Workspace, Val Name, Val TableCollection) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| 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
```bsl title="Code example"
Workspace = "wspdf8yl1yZz3PmWZ";
Name = "TestDatabase";
FieldArray = New Array;
FieldArray.Add(OPI_Airtable.GetNumberField("Number"));
FieldArray.Add(OPI_Airtable.GetStringField("String"));
TableName = "TestTable";
TableCollection = New Map;
TableCollection.Insert(TableName, FieldArray);
Response = OPI_Airtable.CreateDatabase(Token, Workspace, Name, TableCollection); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
```
```sh title="CLI command example"
oint airtable CreateDatabase --token %token% --ws "wspdf8yl1yZz3PmWZ" --title "TestDatabase" --tablesdata %tablesdata%
```
```json title="Result"
{
"id": "applEsyJmBRm12AuN",
"tables": [
{
"id": "tblqZzW78Rvsdt9gt",
"name": "TestTable",
"primaryFieldId": "fldj9Z3fEpLzv40d0",
"fields": [
{
"type": "number",
"options": {
"precision": 0
},
"id": "fldj9Z3fEpLzv40d0",
"name": "Number"
},
{
"type": "richText",
"id": "fldX1kR7lienmcdEj",
"name": "String"
}
],
"views": [
{
"id": "viwbKE3PS9jl6bqJl",
"name": "Grid view",
"type": "grid"
}
]
}
]
}
```

146
docs/en/md/Airtable/Working-with-databases/Get-database-tables.md
View File

@@ -1,73 +1,73 @@
---
sidebar_position: 2
---
# Get base tables
Gets the schema of base tables
*Function GetDatabaseTables(Val Token, Val Base) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Base | --base | String | Base identifier |
Returns: Map Of KeyAndValue - serialized JSON response from Airtable
```bsl title="Code example"
Base = "apptm8Xqo7TwMaipQ";
Response = OPI_Airtable.GetDatabaseTables(Token, Base); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
```
```sh title="CLI command example"
oint airtable GetDatabaseTables --token %token% --base "apptm8Xqo7TwMaipQ"
```
```json title="Result"
{
"tables": [
{
"id": "tblqZzW78Rvsdt9gt",
"name": "TestTable",
"primaryFieldId": "fldj9Z3fEpLzv40d0",
"fields": [
{
"type": "number",
"options": {
"precision": 0
},
"id": "fldj9Z3fEpLzv40d0",
"name": "Number"
},
{
"type": "richText",
"id": "fldX1kR7lienmcdEj",
"name": "String"
}
],
"views": [
{
"id": "viwbKE3PS9jl6bqJl",
"name": "Grid view",
"type": "grid"
}
]
}
]
}
```
---
sidebar_position: 2
---
# Get base tables
Gets the schema of base tables
*Function GetDatabaseTables(Val Token, Val Base) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Base | --base | String | Base identifier |
Returns: Map Of KeyAndValue - serialized JSON response from Airtable
```bsl title="Code example"
Base = "apptm8Xqo7TwMaipQ";
Response = OPI_Airtable.GetDatabaseTables(Token, Base); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
```
```sh title="CLI command example"
oint airtable GetDatabaseTables --token %token% --base "apptm8Xqo7TwMaipQ"
```
```json title="Result"
{
"tables": [
{
"id": "tblqZzW78Rvsdt9gt",
"name": "TestTable",
"primaryFieldId": "fldj9Z3fEpLzv40d0",
"fields": [
{
"type": "number",
"options": {
"precision": 0
},
"id": "fldj9Z3fEpLzv40d0",
"name": "Number"
},
{
"type": "richText",
"id": "fldX1kR7lienmcdEj",
"name": "String"
}
],
"views": [
{
"id": "viwbKE3PS9jl6bqJl",
"name": "Grid view",
"type": "grid"
}
]
}
]
}
```

180
docs/en/md/Airtable/Working-with-databases/Get-list-of-bases.md
View File

@@ -1,90 +1,90 @@
---
sidebar_position: 1
---
# Get list of bases
Gets the list of available bases
*Function GetListOfBases(Val Token, Val Indent = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| 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
```bsl title="Code example"
Response = OPI_Airtable.GetListOfBases(Token); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
```
```sh title="CLI command example"
oint airtable GetListOfBases --token %token% --offset %offset%
```
```json title="Result"
{
"bases": [
{
"id": "appGarzKZ0lu3gzoa",
"name": "Test",
"permissionLevel": "create"
},
{
"id": "app9WRfJirwn3yXuG",
"name": "Product catalog",
"permissionLevel": "create"
},
{
"id": "app6gigUYTzlDEq4X",
"name": "TestDatabase",
"permissionLevel": "create"
},
{
"id": "app5hJGyK8asYYe1Q",
"name": "TestDatabase",
"permissionLevel": "create"
},
{
"id": "appRQ6VxxOZb40Uwi",
"name": "TestDatabase",
"permissionLevel": "create"
},
{
"id": "appM6FaGofV2XSfFA",
"name": "TestDatabase",
"permissionLevel": "create"
},
{
"id": "apptm8Xqo7TwMaipQ",
"name": "TestDatabase",
"permissionLevel": "create"
},
{
"id": "appsyQyGrF8aVN2Wm",
"name": "TestDatabase",
"permissionLevel": "create"
},
{
"id": "applEsyJmBRm12AuN",
"name": "TestDatabase",
"permissionLevel": "create"
}
]
}
```
---
sidebar_position: 1
---
# Get list of bases
Gets the list of available bases
*Function GetListOfBases(Val Token, Val Indent = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| 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
```bsl title="Code example"
Response = OPI_Airtable.GetListOfBases(Token); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
```
```sh title="CLI command example"
oint airtable GetListOfBases --token %token% --offset %offset%
```
```json title="Result"
{
"bases": [
{
"id": "appGarzKZ0lu3gzoa",
"name": "Test",
"permissionLevel": "create"
},
{
"id": "app9WRfJirwn3yXuG",
"name": "Product catalog",
"permissionLevel": "create"
},
{
"id": "app6gigUYTzlDEq4X",
"name": "TestDatabase",
"permissionLevel": "create"
},
{
"id": "app5hJGyK8asYYe1Q",
"name": "TestDatabase",
"permissionLevel": "create"
},
{
"id": "appRQ6VxxOZb40Uwi",
"name": "TestDatabase",
"permissionLevel": "create"
},
{
"id": "appM6FaGofV2XSfFA",
"name": "TestDatabase",
"permissionLevel": "create"
},
{
"id": "apptm8Xqo7TwMaipQ",
"name": "TestDatabase",
"permissionLevel": "create"
},
{
"id": "appsyQyGrF8aVN2Wm",
"name": "TestDatabase",
"permissionLevel": "create"
},
{
"id": "applEsyJmBRm12AuN",
"name": "TestDatabase",
"permissionLevel": "create"
}
]
}
```