askribeKey stringYour secret Askribe key. Can be obtained from your org's settings dashboard |
tableId stringThe tableId of your table. It looks like TXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
columnName string |
description stringThe description of the column |
contextVariableType objectvariableType stringPossible values: [STRING, INTEGER, REAL, BOOLEAN, DATE, TIME, DATE_TIME, IMAGE, AUDIO, VIDEO, FILE, CATEGORY, NLU_ENTITY, BLUEPRINT, LIST, SET, HASHMAP, RICHTEXT] | categoryValues object[] | nluEntityId string | blueprintId string | enumId string | t1Type (circular) | t2Type (circular) | blueprintFields (circular)[] | otherDateTypeBaseType (circular) | dynamicFieldDateMapperType stringPossible values: [UNIX_TIMESTAMP_IN_SECONDS, UNIX_TIMESTAMP_IN_MILLISECONDS, UNIX_TIMESTAMP_IN_NANOSECONDS, STRING_FORMAT] | otherDateStringFormat string |
|
defaultValue objectcontextVariableType objectvariableType stringPossible values: [STRING, INTEGER, REAL, BOOLEAN, DATE, TIME, DATE_TIME, IMAGE, AUDIO, VIDEO, FILE, CATEGORY, NLU_ENTITY, BLUEPRINT, LIST, SET, HASHMAP, RICHTEXT] | categoryValues object[] | nluEntityId string | blueprintId string | enumId string | t1Type (circular) | t2Type (circular) | blueprintFields (circular)[] | otherDateTypeBaseType (circular) | dynamicFieldDateMapperType stringPossible values: [UNIX_TIMESTAMP_IN_SECONDS, UNIX_TIMESTAMP_IN_MILLISECONDS, UNIX_TIMESTAMP_IN_NANOSECONDS, STRING_FORMAT] | otherDateStringFormat string |
| value string |
|
specialType stringPossible values: [NONE, CREATED_AT, UPDATED_AT, CREATED_BY, UPDATED_BY, FOREIGN_KEY, LOOKUP_COLUMN, USER, CONTACT] Used to indicate if a column is special type like foreign key, lookup column, etc. |
overriddenType stringPossible values: [NONE, MULTI_LINE, PHONE_NUMBER, EMAIL, URL, CURRENCY, PERCENT, DURATION, RATING, AUTONUMBER, BARCODE, QR, BUTTON] Used to indicate if a column has custom formatting type like multi-line, phone number, url etc. |
isFormula booleanIs the column a formula column |
formulaExpression stringFormula of the column if the column is of formula type |
fkReferredTableId stringThe id of the referred table if the column is a foreign key or lookup column |
backingColumnId stringThe id of the backing column if the column is a foreign key or lookup column |
fkReferMultipleRows booleanIs the foreign key column referring to multiple rows |
fkIsSelectionLimitedToView booleanIs the foreign key selection limited to a view |
fkLimitSelectionToViewId stringThe id of the view to which the foreign key selection is limited |
fkIsSelectionLimitedToCondition booleanIs the foreign key selection limited to a condition |
fkLimitSelectionToCondition stringThe condition to which the foreign key selection is limited |
lookupColumnReferredColumnId stringThe column which the lookup column is referring to |
lookupIsItemsShownLimited booleanIs the lookup column showing limited items |
lookupShownItemsLimitedType stringPossible values: [FIRST, LAST, TOP] How are the loookup column items limited |
lookupShownItemsLimitedValue int32The value of the limit when lookup column shows limited items |
isReferenceType booleanIs the column a reference type. Applicable when the column is a QR type or Barcode Type |
referredSourceColumnId stringThe id of the source column if the column is a reference type |
referredCDPPrimaryFieldId stringThe id of the primary field of the referred CDP if the column is of CONTACT type |
isIdentifier booleanIs unique constraint applicable on columns |
isMandatory booleanAre non-null values allowed on column |
barcodeFormats string[]Allowed barcode formats if the column is of barcode type |
buttonLabel stringLabel of the button if the column is of button type |
buttonStyle stringStyle of the button if the column is of button type |
customTableButtonActionType stringPossible values: [OPEN_URL, TRIGGER_FLOW, EMBED_IFRAME] Action type of the button if the column is of button type |
buttonURL stringURL of the button if the column is of button type and customTableButtonActionType = OPEN_URL | EMBED_IFRAME |
buttonTriggerFlowId stringFlow id to be triggered if the column is of button type and customTableButtonActionType = TRIGGER_FLOW |
buttonTriggerNodeId stringNode id to be triggered if the column is of button type and customTableButtonActionType = TRIGGER_FLOW |
formattingOptions objectFormatting options for the column |