You've already forked OpenIntegrations
mirror of
https://github.com/Bayselonarrend/OpenIntegrations.git
synced 2025-11-23 22:05:15 +02:00
Создание MD файлов документации
This commit is contained in:
committed by
Vitaly the Alpaca (bot)
parent
d84469da0e
commit
bf088ac606
@@ -1,55 +1,55 @@
|
||||
---
|
||||
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 | Destination |
|
||||
|-|-|-|-|
|
||||
| Token | --token | String | Token |
|
||||
| Base | --base | String | Base identifier |
|
||||
| Table | --table | String | Table identifier |
|
||||
| FieldStructure | --fielddata | Structure of Key-Value | Description of the new field |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON response from Airtable
|
||||
|
||||
```bsl title="Code example"
|
||||
|
||||
|
||||
Base = "apptm8Xqo7TwMaipQ";
|
||||
Table = "tbl9G4jVoTJpxYwSY";
|
||||
Name = String(New UUID);
|
||||
Field = OPI_Airtable.GetNumberField(Name);
|
||||
|
||||
Response = OPI_Airtable.CreateField(Token, Base, Table, FieldStructure); //Map
|
||||
Response = OPI_Tools.JSONString(Response); //JSON string
|
||||
|
||||
|
||||
|
||||
```
|
||||
|
||||
```sh title="CLI command example"
|
||||
|
||||
oint airtable CreateField --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --fielddata %fielddata%
|
||||
|
||||
|
||||
```
|
||||
|
||||
|
||||
```json title="Result"
|
||||
|
||||
{
|
||||
"type": "number",
|
||||
"options": {
|
||||
"precision": 0
|
||||
},
|
||||
"id": "fld3IbFtHZtBHQwsk",
|
||||
"name": "9c0d2a82-7bf9-40b7-8052-ae3ebadc72d5"
|
||||
}
|
||||
|
||||
```
|
||||
---
|
||||
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 | Destination |
|
||||
|-|-|-|-|
|
||||
| Token | --token | String | Token |
|
||||
| Base | --base | String | Base identifier |
|
||||
| Table | --table | String | Table identifier |
|
||||
| FieldStructure | --fielddata | Structure of Key-Value | Description of the new field |
|
||||
|
||||
|
||||
Returns: Map Of KeyAndValue - serialized JSON response from Airtable
|
||||
|
||||
```bsl title="Code example"
|
||||
|
||||
|
||||
Base = "apptm8Xqo7TwMaipQ";
|
||||
Table = "tbl9G4jVoTJpxYwSY";
|
||||
Name = String(New UUID);
|
||||
Field = OPI_Airtable.GetNumberField(Name);
|
||||
|
||||
Response = OPI_Airtable.CreateField(Token, Base, Table, FieldStructure); //Map
|
||||
Response = OPI_Tools.JSONString(Response); //JSON string
|
||||
|
||||
|
||||
|
||||
```
|
||||
|
||||
```sh title="CLI command example"
|
||||
|
||||
oint airtable CreateField --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --fielddata %fielddata%
|
||||
|
||||
|
||||
```
|
||||
|
||||
|
||||
```json title="Result"
|
||||
|
||||
{
|
||||
"type": "number",
|
||||
"options": {
|
||||
"precision": 0
|
||||
},
|
||||
"id": "fld3IbFtHZtBHQwsk",
|
||||
"name": "9c0d2a82-7bf9-40b7-8052-ae3ebadc72d5"
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
@@ -1,45 +1,45 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
---
|
||||
|
||||
# Get field (file)
|
||||
Gets the description of a file field
|
||||
|
||||
|
||||
*Function GetAttachmentField(Val Name) Export*
|
||||
|
||||
| Parameter | CLI option | Type | Destination |
|
||||
|-|-|-|-|
|
||||
| Name | --title | String | Field name |
|
||||
|
||||
|
||||
Returns: Structure - Field description
|
||||
|
||||
```bsl title="Code example"
|
||||
|
||||
|
||||
Name = "Attachment";
|
||||
|
||||
Response = OPI_Airtable.GetAttachmentField(Name); //Map
|
||||
Response = OPI_Tools.JSONString(Response); //JSON string
|
||||
|
||||
|
||||
|
||||
```
|
||||
|
||||
```sh title="CLI command example"
|
||||
|
||||
oint airtable GetAttachmentField --title "Attachment"
|
||||
|
||||
|
||||
```
|
||||
|
||||
|
||||
```json title="Result"
|
||||
|
||||
{
|
||||
"name": "Attachment",
|
||||
"type": "multipleAttachments"
|
||||
}
|
||||
|
||||
```
|
||||
---
|
||||
sidebar_position: 5
|
||||
---
|
||||
|
||||
# Get field (file)
|
||||
Gets the description of a file field
|
||||
|
||||
|
||||
*Function GetAttachmentField(Val Name) Export*
|
||||
|
||||
| Parameter | CLI option | Type | Destination |
|
||||
|-|-|-|-|
|
||||
| Name | --title | String | Field name |
|
||||
|
||||
|
||||
Returns: Structure - Field description
|
||||
|
||||
```bsl title="Code example"
|
||||
|
||||
|
||||
Name = "Attachment";
|
||||
|
||||
Response = OPI_Airtable.GetAttachmentField(Name); //Map
|
||||
Response = OPI_Tools.JSONString(Response); //JSON string
|
||||
|
||||
|
||||
|
||||
```
|
||||
|
||||
```sh title="CLI command example"
|
||||
|
||||
oint airtable GetAttachmentField --title "Attachment"
|
||||
|
||||
|
||||
```
|
||||
|
||||
|
||||
```json title="Result"
|
||||
|
||||
{
|
||||
"name": "Attachment",
|
||||
"type": "multipleAttachments"
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
@@ -1,49 +1,49 @@
|
||||
---
|
||||
sidebar_position: 6
|
||||
---
|
||||
|
||||
# Get field (checkbox)
|
||||
Gets the description of a boolean field
|
||||
|
||||
|
||||
*Function GetCheckboxField(Val Name) Export*
|
||||
|
||||
| Parameter | CLI option | Type | Destination |
|
||||
|-|-|-|-|
|
||||
| Name | --title | String | Field name |
|
||||
|
||||
|
||||
Returns: Structure - Field description
|
||||
|
||||
```bsl title="Code example"
|
||||
|
||||
|
||||
Name = "Checkbox";
|
||||
|
||||
Response = OPI_Airtable.GetCheckboxField(Name); //Map
|
||||
Response = OPI_Tools.JSONString(Response); //JSON string
|
||||
|
||||
|
||||
|
||||
```
|
||||
|
||||
```sh title="CLI command example"
|
||||
|
||||
oint airtable GetCheckboxField --title "Checkbox"
|
||||
|
||||
|
||||
```
|
||||
|
||||
|
||||
```json title="Result"
|
||||
|
||||
{
|
||||
"name": "Checkbox",
|
||||
"type": "checkbox",
|
||||
"options": {
|
||||
"icon": "check",
|
||||
"color": "yellowBright"
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
---
|
||||
sidebar_position: 6
|
||||
---
|
||||
|
||||
# Get field (checkbox)
|
||||
Gets the description of a boolean field
|
||||
|
||||
|
||||
*Function GetCheckboxField(Val Name) Export*
|
||||
|
||||
| Parameter | CLI option | Type | Destination |
|
||||
|-|-|-|-|
|
||||
| Name | --title | String | Field name |
|
||||
|
||||
|
||||
Returns: Structure - Field description
|
||||
|
||||
```bsl title="Code example"
|
||||
|
||||
|
||||
Name = "Checkbox";
|
||||
|
||||
Response = OPI_Airtable.GetCheckboxField(Name); //Map
|
||||
Response = OPI_Tools.JSONString(Response); //JSON string
|
||||
|
||||
|
||||
|
||||
```
|
||||
|
||||
```sh title="CLI command example"
|
||||
|
||||
oint airtable GetCheckboxField --title "Checkbox"
|
||||
|
||||
|
||||
```
|
||||
|
||||
|
||||
```json title="Result"
|
||||
|
||||
{
|
||||
"name": "Checkbox",
|
||||
"type": "checkbox",
|
||||
"options": {
|
||||
"icon": "check",
|
||||
"color": "yellowBright"
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
@@ -1,51 +1,51 @@
|
||||
---
|
||||
sidebar_position: 7
|
||||
---
|
||||
|
||||
# Get field (date)
|
||||
Gets the description of a date field
|
||||
|
||||
|
||||
*Function GetDateField(Val Name) Export*
|
||||
|
||||
| Parameter | CLI option | Type | Destination |
|
||||
|-|-|-|-|
|
||||
| Name | --title | String | Field name |
|
||||
|
||||
|
||||
Returns: Structure - Field description
|
||||
|
||||
```bsl title="Code example"
|
||||
|
||||
|
||||
Name = "Date";
|
||||
|
||||
Response = OPI_Airtable.GetDateField(Name); //Map
|
||||
Response = OPI_Tools.JSONString(Response); //JSON string
|
||||
|
||||
|
||||
|
||||
```
|
||||
|
||||
```sh title="CLI command example"
|
||||
|
||||
oint airtable GetDateField --title "Date"
|
||||
|
||||
|
||||
```
|
||||
|
||||
|
||||
```json title="Result"
|
||||
|
||||
{
|
||||
"name": "Date",
|
||||
"type": "date",
|
||||
"options": {
|
||||
"dateFormat": {
|
||||
"format": "YYYY-MM-DD",
|
||||
"name": "iso"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
---
|
||||
sidebar_position: 7
|
||||
---
|
||||
|
||||
# Get field (date)
|
||||
Gets the description of a date field
|
||||
|
||||
|
||||
*Function GetDateField(Val Name) Export*
|
||||
|
||||
| Parameter | CLI option | Type | Destination |
|
||||
|-|-|-|-|
|
||||
| Name | --title | String | Field name |
|
||||
|
||||
|
||||
Returns: Structure - Field description
|
||||
|
||||
```bsl title="Code example"
|
||||
|
||||
|
||||
Name = "Date";
|
||||
|
||||
Response = OPI_Airtable.GetDateField(Name); //Map
|
||||
Response = OPI_Tools.JSONString(Response); //JSON string
|
||||
|
||||
|
||||
|
||||
```
|
||||
|
||||
```sh title="CLI command example"
|
||||
|
||||
oint airtable GetDateField --title "Date"
|
||||
|
||||
|
||||
```
|
||||
|
||||
|
||||
```json title="Result"
|
||||
|
||||
{
|
||||
"name": "Date",
|
||||
"type": "date",
|
||||
"options": {
|
||||
"dateFormat": {
|
||||
"format": "YYYY-MM-DD",
|
||||
"name": "iso"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
@@ -1,45 +1,45 @@
|
||||
---
|
||||
sidebar_position: 8
|
||||
---
|
||||
|
||||
# Get field (email)
|
||||
Gets the description of an email field
|
||||
|
||||
|
||||
*Function GetEmailField(Val Name) Export*
|
||||
|
||||
| Parameter | CLI option | Type | Destination |
|
||||
|-|-|-|-|
|
||||
| Name | --title | String | Field name |
|
||||
|
||||
|
||||
Returns: Structure - Field description
|
||||
|
||||
```bsl title="Code example"
|
||||
|
||||
|
||||
Name = "Email";
|
||||
|
||||
Response = OPI_Airtable.GetEmailField(Name); //Map
|
||||
Response = OPI_Tools.JSONString(Response); //JSON string
|
||||
|
||||
|
||||
|
||||
```
|
||||
|
||||
```sh title="CLI command example"
|
||||
|
||||
oint airtable GetEmailField --title "Email"
|
||||
|
||||
|
||||
```
|
||||
|
||||
|
||||
```json title="Result"
|
||||
|
||||
{
|
||||
"name": "Email",
|
||||
"type": "email"
|
||||
}
|
||||
|
||||
```
|
||||
---
|
||||
sidebar_position: 8
|
||||
---
|
||||
|
||||
# Get field (email)
|
||||
Gets the description of an email field
|
||||
|
||||
|
||||
*Function GetEmailField(Val Name) Export*
|
||||
|
||||
| Parameter | CLI option | Type | Destination |
|
||||
|-|-|-|-|
|
||||
| Name | --title | String | Field name |
|
||||
|
||||
|
||||
Returns: Structure - Field description
|
||||
|
||||
```bsl title="Code example"
|
||||
|
||||
|
||||
Name = "Email";
|
||||
|
||||
Response = OPI_Airtable.GetEmailField(Name); //Map
|
||||
Response = OPI_Tools.JSONString(Response); //JSON string
|
||||
|
||||
|
||||
|
||||
```
|
||||
|
||||
```sh title="CLI command example"
|
||||
|
||||
oint airtable GetEmailField --title "Email"
|
||||
|
||||
|
||||
```
|
||||
|
||||
|
||||
```json title="Result"
|
||||
|
||||
{
|
||||
"name": "Email",
|
||||
"type": "email"
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
@@ -1,45 +1,45 @@
|
||||
---
|
||||
sidebar_position: 10
|
||||
---
|
||||
|
||||
# Get field (url)
|
||||
Gets the description of a URL field
|
||||
|
||||
|
||||
*Function GetLinkField(Val Name) Export*
|
||||
|
||||
| Parameter | CLI option | Type | Destination |
|
||||
|-|-|-|-|
|
||||
| Name | --title | String | Field name |
|
||||
|
||||
|
||||
Returns: Structure - Field description
|
||||
|
||||
```bsl title="Code example"
|
||||
|
||||
|
||||
Name = "Link";
|
||||
|
||||
Response = OPI_Airtable.GetLinkField(Name); //Map
|
||||
Response = OPI_Tools.JSONString(Response); //JSON string
|
||||
|
||||
|
||||
|
||||
```
|
||||
|
||||
```sh title="CLI command example"
|
||||
|
||||
oint airtable GetLinkField --title "Link"
|
||||
|
||||
|
||||
```
|
||||
|
||||
|
||||
```json title="Result"
|
||||
|
||||
{
|
||||
"name": "Link",
|
||||
"type": "url"
|
||||
}
|
||||
|
||||
```
|
||||
---
|
||||
sidebar_position: 10
|
||||
---
|
||||
|
||||
# Get field (url)
|
||||
Gets the description of a URL field
|
||||
|
||||
|
||||
*Function GetLinkField(Val Name) Export*
|
||||
|
||||
| Parameter | CLI option | Type | Destination |
|
||||
|-|-|-|-|
|
||||
| Name | --title | String | Field name |
|
||||
|
||||
|
||||
Returns: Structure - Field description
|
||||
|
||||
```bsl title="Code example"
|
||||
|
||||
|
||||
Name = "Link";
|
||||
|
||||
Response = OPI_Airtable.GetLinkField(Name); //Map
|
||||
Response = OPI_Tools.JSONString(Response); //JSON string
|
||||
|
||||
|
||||
|
||||
```
|
||||
|
||||
```sh title="CLI command example"
|
||||
|
||||
oint airtable GetLinkField --title "Link"
|
||||
|
||||
|
||||
```
|
||||
|
||||
|
||||
```json title="Result"
|
||||
|
||||
{
|
||||
"name": "Link",
|
||||
"type": "url"
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
@@ -1,50 +1,50 @@
|
||||
---
|
||||
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 | Destination |
|
||||
|-|-|-|-|
|
||||
| Name | --title | String | New field name |
|
||||
| Precision | --precision | Number, String | Number of decimal places |
|
||||
|
||||
|
||||
Returns: Structure - Field description
|
||||
|
||||
```bsl title="Code example"
|
||||
|
||||
|
||||
Name = "Number";
|
||||
Precision = "0";
|
||||
|
||||
Response = OPI_Airtable.GetNumberField(Name, Precision); //Map
|
||||
Response = OPI_Tools.JSONString(Response); //JSON string
|
||||
|
||||
|
||||
|
||||
```
|
||||
|
||||
```sh title="CLI command example"
|
||||
|
||||
oint airtable GetNumberField --title "Number" --precision "0"
|
||||
|
||||
|
||||
```
|
||||
|
||||
|
||||
```json title="Result"
|
||||
|
||||
{
|
||||
"name": "Number",
|
||||
"type": "number",
|
||||
"options": {
|
||||
"precision": 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 | Destination |
|
||||
|-|-|-|-|
|
||||
| Name | --title | String | New field name |
|
||||
| Precision | --precision | Number, String | Number of decimal places |
|
||||
|
||||
|
||||
Returns: Structure - Field description
|
||||
|
||||
```bsl title="Code example"
|
||||
|
||||
|
||||
Name = "Number";
|
||||
Precision = "0";
|
||||
|
||||
Response = OPI_Airtable.GetNumberField(Name, Precision); //Map
|
||||
Response = OPI_Tools.JSONString(Response); //JSON string
|
||||
|
||||
|
||||
|
||||
```
|
||||
|
||||
```sh title="CLI command example"
|
||||
|
||||
oint airtable GetNumberField --title "Number" --precision "0"
|
||||
|
||||
|
||||
```
|
||||
|
||||
|
||||
```json title="Result"
|
||||
|
||||
{
|
||||
"name": "Number",
|
||||
"type": "number",
|
||||
"options": {
|
||||
"precision": 0
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
@@ -1,45 +1,45 @@
|
||||
---
|
||||
sidebar_position: 9
|
||||
---
|
||||
|
||||
# Get field (phone)
|
||||
Gets the description of a phone number field
|
||||
|
||||
|
||||
*Function GetPhoneField(Val Name) Export*
|
||||
|
||||
| Parameter | CLI option | Type | Destination |
|
||||
|-|-|-|-|
|
||||
| Name | --title | String | Field name |
|
||||
|
||||
|
||||
Returns: Structure - Field description
|
||||
|
||||
```bsl title="Code example"
|
||||
|
||||
|
||||
Name = "Phone";
|
||||
|
||||
Response = OPI_Airtable.GetPhoneField(Name); //Map
|
||||
Response = OPI_Tools.JSONString(Response); //JSON string
|
||||
|
||||
|
||||
|
||||
```
|
||||
|
||||
```sh title="CLI command example"
|
||||
|
||||
oint airtable GetPhoneField --title "Phone"
|
||||
|
||||
|
||||
```
|
||||
|
||||
|
||||
```json title="Result"
|
||||
|
||||
{
|
||||
"name": "Phone",
|
||||
"type": "phoneNumber"
|
||||
}
|
||||
|
||||
```
|
||||
---
|
||||
sidebar_position: 9
|
||||
---
|
||||
|
||||
# Get field (phone)
|
||||
Gets the description of a phone number field
|
||||
|
||||
|
||||
*Function GetPhoneField(Val Name) Export*
|
||||
|
||||
| Parameter | CLI option | Type | Destination |
|
||||
|-|-|-|-|
|
||||
| Name | --title | String | Field name |
|
||||
|
||||
|
||||
Returns: Structure - Field description
|
||||
|
||||
```bsl title="Code example"
|
||||
|
||||
|
||||
Name = "Phone";
|
||||
|
||||
Response = OPI_Airtable.GetPhoneField(Name); //Map
|
||||
Response = OPI_Tools.JSONString(Response); //JSON string
|
||||
|
||||
|
||||
|
||||
```
|
||||
|
||||
```sh title="CLI command example"
|
||||
|
||||
oint airtable GetPhoneField --title "Phone"
|
||||
|
||||
|
||||
```
|
||||
|
||||
|
||||
```json title="Result"
|
||||
|
||||
{
|
||||
"name": "Phone",
|
||||
"type": "phoneNumber"
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
@@ -1,45 +1,45 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# Get field (string)
|
||||
Gets the description of a string field
|
||||
|
||||
|
||||
*Function GetStringField(Val Name) Export*
|
||||
|
||||
| Parameter | CLI option | Type | Destination |
|
||||
|-|-|-|-|
|
||||
| Name | --title | String | New field name |
|
||||
|
||||
|
||||
Returns: Structure - Field description
|
||||
|
||||
```bsl title="Code example"
|
||||
|
||||
|
||||
Name = "String";
|
||||
|
||||
Response = OPI_Airtable.GetStringField(Name); //Map
|
||||
Response = OPI_Tools.JSONString(Response); //JSON string
|
||||
|
||||
|
||||
|
||||
```
|
||||
|
||||
```sh title="CLI command example"
|
||||
|
||||
oint airtable GetStringField --title "String"
|
||||
|
||||
|
||||
```
|
||||
|
||||
|
||||
```json title="Result"
|
||||
|
||||
{
|
||||
"name": "String",
|
||||
"type": "richText"
|
||||
}
|
||||
|
||||
```
|
||||
---
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# Get field (string)
|
||||
Gets the description of a string field
|
||||
|
||||
|
||||
*Function GetStringField(Val Name) Export*
|
||||
|
||||
| Parameter | CLI option | Type | Destination |
|
||||
|-|-|-|-|
|
||||
| Name | --title | String | New field name |
|
||||
|
||||
|
||||
Returns: Structure - Field description
|
||||
|
||||
```bsl title="Code example"
|
||||
|
||||
|
||||
Name = "String";
|
||||
|
||||
Response = OPI_Airtable.GetStringField(Name); //Map
|
||||
Response = OPI_Tools.JSONString(Response); //JSON string
|
||||
|
||||
|
||||
|
||||
```
|
||||
|
||||
```sh title="CLI command example"
|
||||
|
||||
oint airtable GetStringField --title "String"
|
||||
|
||||
|
||||
```
|
||||
|
||||
|
||||
```json title="Result"
|
||||
|
||||
{
|
||||
"name": "String",
|
||||
"type": "richText"
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
@@ -1,59 +1,59 @@
|
||||
---
|
||||
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 | Destination |
|
||||
|-|-|-|-|
|
||||
| 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
|
||||
|
||||
```bsl title="Code example"
|
||||
|
||||
|
||||
Base = "apptm8Xqo7TwMaipQ";
|
||||
Table = "tbl9G4jVoTJpxYwSY";
|
||||
Field = "fld3IbFtHZtBHQwsk";
|
||||
Name = String(New UUID) + "(change.)";
|
||||
Description = "New description";
|
||||
|
||||
Response = OPI_Airtable.ModifyField(Token, Base, Table, Field, Name, Description); //Map
|
||||
Response = OPI_Tools.JSONString(Response); //JSON string
|
||||
|
||||
|
||||
|
||||
```
|
||||
|
||||
```sh title="CLI command example"
|
||||
|
||||
oint airtable ModifyField --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --field "fld3IbFtHZtBHQwsk" --title %title% --description "New description"
|
||||
|
||||
|
||||
```
|
||||
|
||||
|
||||
```json title="Result"
|
||||
|
||||
{
|
||||
"type": "number",
|
||||
"options": {
|
||||
"precision": 0
|
||||
},
|
||||
"id": "fld3IbFtHZtBHQwsk",
|
||||
"name": "9c0d2a82-7bf9-40b7-8052-ae3ebadc72d5(change.)",
|
||||
"description": "New description"
|
||||
}
|
||||
|
||||
```
|
||||
---
|
||||
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 | Destination |
|
||||
|-|-|-|-|
|
||||
| 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
|
||||
|
||||
```bsl title="Code example"
|
||||
|
||||
|
||||
Base = "apptm8Xqo7TwMaipQ";
|
||||
Table = "tbl9G4jVoTJpxYwSY";
|
||||
Field = "fld3IbFtHZtBHQwsk";
|
||||
Name = String(New UUID) + "(change.)";
|
||||
Description = "New description";
|
||||
|
||||
Response = OPI_Airtable.ModifyField(Token, Base, Table, Field, Name, Description); //Map
|
||||
Response = OPI_Tools.JSONString(Response); //JSON string
|
||||
|
||||
|
||||
|
||||
```
|
||||
|
||||
```sh title="CLI command example"
|
||||
|
||||
oint airtable ModifyField --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --field "fld3IbFtHZtBHQwsk" --title %title% --description "New description"
|
||||
|
||||
|
||||
```
|
||||
|
||||
|
||||
```json title="Result"
|
||||
|
||||
{
|
||||
"type": "number",
|
||||
"options": {
|
||||
"precision": 0
|
||||
},
|
||||
"id": "fld3IbFtHZtBHQwsk",
|
||||
"name": "9c0d2a82-7bf9-40b7-8052-ae3ebadc72d5(change.)",
|
||||
"description": "New description"
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user