Quickbase (независимый издатель)

Quickbase — это платформа разработки приложений, которая объединяет бизнес-отделы и ИТ-отделы, позволяя решениям проблем любого технического уровня работать вместе для безопасной, безопасной и устойчивой создания экосистемы приложений. Quickbase помогает предприятиям ускорить непрерывные инновации уникальных процессов, обеспечивая развитие граждан в масштабе одной общей платформы.

Этот соединитель доступен в следующих продуктах и регионах:

Услуга	Class	Регионы
Copilot Studio	Премия	Все регионы Power Automate , кроме следующих:      - Правительство США (GCC)      - Правительство США (GCC High)      — Облако Китая, управляемое 21Vianet      - Министерство обороны США (DoD)
Логические приложения	Стандарт	Все регионы Logic Apps , кроме следующих:      — Регионы Azure для государственных организаций      — Регионы Azure Для Китая      - Министерство обороны США (DoD)
Power Apps	Премия	Все регионы Power Apps , кроме следующих:      - Правительство США (GCC)      - Правительство США (GCC High)      — Облако Китая, управляемое 21Vianet      - Министерство обороны США (DoD)
Power Automate	Премия	Все регионы Power Automate , кроме следующих:      - Правительство США (GCC)      - Правительство США (GCC High)      — Облако Китая, управляемое 21Vianet      - Министерство обороны США (DoD)

Контакт
Имя	Трой Тейлор
URL	https://www.hitachisolutions.com
Адрес электронной почты	ttaylor@hitachisolutions.com

Метаданные соединителя
Publisher	Трой Тейлор, Решения Похасти
Веб-сайт	https://www.quickbase.com/
Политика конфиденциальности	https://www.quickbase.com/privacy
Категории	Производительность; ИТ-операции

Создание подключения

Соединитель поддерживает следующие типы проверки подлинности:

По умолчанию	Параметры для создания подключения.	Все регионы	Недоступен для совместного использования

По умолчанию

Применимо: все регионы

Параметры для создания подключения.

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

Имя	Тип	Description	Обязательно
Имя узла области	струна	Укажите имя узла области.	True
Authorization	securestring	Маркер пользователя в форме QB-USER-TOKEN yourToken.	True

Ограничения регулирования

Имя	Вызовы	Период обновления
Вызовы API для каждого подключения	100	60 секунд

Действия

Вставка записей об обновлении иоров	Вставка и/или обновление записей в таблицу. В этом вызове API можно отправлять вставки и обновления. Обновление может использовать ключевое поле в таблице или любое другое поддерживаемое уникальное поле. Дополнительные сведения о форматировании каждого типа поля см. на странице типов полей . Эта операция обеспечивает добавочную обработку успешных записей, даже если некоторые записи завершаются ошибкой. Заметка: Эта конечная точка поддерживает максимальный размер полезных данных в 10 МБ.
Выполнение отчета	Запускает отчет на основе идентификатора и возвращает базовые данные, связанные с ним. Формат данных зависит от типа отчета. Отчеты, ориентированные на данные на уровне записей (таблица, календарь и т. д.), возвращают отдельные записи. Статистические отчеты (сводка, диаграмма) возвращают суммированные сведения, настроенные в отчете. Элементы, относящиеся к пользовательскому интерфейсу, не возвращаются, например итоги, средние и визуализации. Возвращает данные с интеллектуальной разбивкой на страницы на основе приблизительного размера каждой записи. Объект метаданных будет содержать необходимые сведения для итерации ответа и сбора дополнительных данных.
Выполнение формулы	Позволяет выполнять формулу с помощью вызова API. Используйте этот метод в пользовательском коде, чтобы получить значение обратно формулы без дискретного поля в записи.
Запрос данных	Передайте запрос на языке запросов Quickbase. Возвращает данные записи с интеллектуальной разбивкой на страницы на основе приблизительного размера каждой записи. Объект метаданных будет содержать необходимые сведения для итерации ответа и сбора дополнительных данных.
Клонирование маркера пользователя	Клонирует маркер пользователя, прошедший проверку подлинности. Все приложения, связанные с этим маркером, автоматически связываются с новым маркером.
Копирование приложения	Копирует указанное приложение. Новое приложение будет иметь ту же схему, что и исходная. Дополнительные параметры копирования см. ниже.
Обновление поля	Обновляет свойства и пользовательские разрешения поля. Попытка обновить определенные свойства может привести к тому, что существующие данные больше не подчиняются новым свойствам поля и могут быть отклонены. См. описание обязательных, уникальных и вариантов, приведенных ниже, для конкретных ситуаций. Все свойства поля, которое не указано в тексте запроса, останутся неизменными.
Обновление приложения	Обновляет основные свойства и (или) переменные приложения для конкретного приложения. Все свойства приложения, которое не указано в тексте запроса, останутся неизменными.
Обновление связи	Используйте эту конечную точку для добавления полей подстановки и полей сводки в существующую связь. Обновление связи не приведет к удалению существующих полей подстановки и сводки.
Обновление таблицы	Обновляет основные свойства определенной таблицы. Все свойства таблицы, которая не указана в тексте запроса, останутся неизменными.
Отключение маркера пользователя	Деактивирует маркер пользователя, прошедший проверку подлинности. После этого маркер пользователя должен быть повторно активирован в пользовательском интерфейсе.
Получение временного маркера для DBID	Используйте эту конечную точку для получения временного маркера авторизации в пределах приложения или таблицы. Затем этот маркер можно использовать для выполнения других вызовов API (см. авторизацию). Срок действия этого маркера истекает через 5 минут.
Получение всех отчетов таблицы	Получение схемы (свойств) всех отчетов для таблицы. Если пользователь, выполняющий API, является администратором приложения, API также вернет все личные отчеты с идентификатором пользователя владельца.
Получение всех связей	Получение списка всех связей и их определений для определенной таблицы. Сведения предоставляются как для родительских, так и дочерних сторон отношений в данном приложении. Ограниченные сведения возвращаются для связей между приложениями.
Получение использования для всех полей	Получение всей статистики использования полей для таблицы. Это сводка сведений, которые можно найти в таблице использования свойств поля.
Получение использования поля	Получение статистики использования отдельных полей. Это сводка сведений, которые можно найти в таблице использования свойств поля.
Получение отчета	Получение схемы (свойств) отдельного отчета.
Получение полей для таблицы	Возвращает свойства для всех полей в определенной таблице. Свойства для каждого поля совпадают с свойствами в поле Get.
Получение поля	Возвращает свойства отдельного поля на основе идентификатора поля. Свойства, присутствующих во всех типах полей, возвращаются на верхнем уровне. Свойства, уникальные для определенного типа поля, возвращаются в атрибуте properties. Дополнительные сведения о свойствах каждого типа поля см. на странице типов полей.
Получение приложения	Возвращает основные свойства приложения, включая переменные приложения.
Получение событий приложения	Получите список событий, которые могут быть активированы на основе данных или действий пользователей в этом приложении, включает в себя: уведомление по электронной почте, напоминания, подписки, действия QB, веб-перехватчики, триггеры изменений записи (не включают запланированные).
Получение таблиц для приложения	Возвращает список всех таблиц, существующих в определенном приложении. Свойства для каждой таблицы совпадают с тем, что возвращается в таблице Get.
Получение таблицы	Возвращает свойства отдельной таблицы, которая является частью приложения.
Скачивание вложения	Загружает вложение файла с содержимым вложения файла, закодированного в формате base64. Ответ API возвращает имя файла в заголовке Content-Disposition . Метаданные о файлах можно получить из конечных точек /records и /reports, где это применимо. Используйте эти конечные точки для получения необходимых сведений для получения файлов.
Создание поля	Создает поле в таблице, включая пользовательские разрешения этого поля.
Создание связи	Создает связь в таблице, а также поля подстановки и сводки. Связи можно создавать только для таблиц в одном приложении.
Создание таблицы	Создает таблицу в приложении.
Создать приложение	Создает приложение в учетной записи. У вас должны быть права на создание приложения в соответствующей учетной записи. Основные свойства и переменные приложения можно задать с помощью этого API.
Удаление вложения	Удаляет одну версию вложения файла. Метаданные о файлах можно получить из конечных точек /records и /reports, где это применимо. Используйте эти конечные точки, чтобы получить необходимые сведения для удаления версий файлов.
Удаление записей	Удаляет записи в таблице на основе запроса. Кроме того, можно удалить все записи в таблице.
Удаление маркера пользователя	Удаляет маркер пользователя, прошедший проверку подлинности. Это не является обратимым.
Удаление полей	Удаляет одно или несколько полей в таблице на основе идентификатора поля. Это также будет окончательно удалять любые данные или вычисления в этом поле.
Удаление приложения	Удаляет все приложение, включая все таблицы и данные.
Удаление связи	Используйте эту конечную точку для удаления всей связи, включая все поля подстановки и сводки. Поле ссылки в связи не будет удалено.
Удалить таблицу	Удаляет определенную таблицу в приложении, включая все данные в нем.

Вставка записей об обновлении иоров

Идентификатор операции:

UpsertRecords

Вставка и/или обновление записей в таблицу. В этом вызове API можно отправлять вставки и обновления. Обновление может использовать ключевое поле в таблице или любое другое поддерживаемое уникальное поле. Дополнительные сведения о форматировании каждого типа поля см. на странице типов полей . Эта операция обеспечивает добавочную обработку успешных записей, даже если некоторые записи завершаются ошибкой.
Заметка: Эта конечная точка поддерживает максимальный размер полезных данных в 10 МБ.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Кому	to	True	string	Идентификатор таблицы.
данные	data		object
mergeFieldId	mergeFieldId		integer	Идентификатор поля слияния.
fieldsToReturn	fieldsToReturn		array of integer	Укажите массив идентификаторов полей, которые будут возвращать данные для любых обновлений или добавленной записи. Идентификатор записи (FID 3) всегда возвращается, если запрашивается любой идентификатор поля.

Возвращаемое значение

Успешный ответ, содержащий сведения о записях, добавленных, обновленных или без изменений. В приведенном ниже примере таблица ранее имела десять записей с идентификаторами от 1 до 10. Пользователь публикует upsert, который обновляет значение записи 1 и добавляет две новые записи, все успешно.

Ответ Upsert

upsertResponse

Выполнение отчета

Идентификатор операции:

RunReport

Запускает отчет на основе идентификатора и возвращает базовые данные, связанные с ним. Формат данных зависит от типа отчета. Отчеты, ориентированные на данные на уровне записей (таблица, календарь и т. д.), возвращают отдельные записи. Статистические отчеты (сводка, диаграмма) возвращают суммированные сведения, настроенные в отчете. Элементы, относящиеся к пользовательскому интерфейсу, не возвращаются, например итоги, средние и визуализации. Возвращает данные с интеллектуальной разбивкой на страницы на основе приблизительного размера каждой записи. Объект метаданных будет содержать необходимые сведения для итерации ответа и сбора дополнительных данных.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Код(ID) таблицы	tableId	True	string	Идентификатор таблицы для отчета.
Пропустить	skip		integer	Количество пропускаемых записей. Это значение можно задать при разбивке на страницы с помощью набора результатов.
Верх	top		integer	Максимальное количество возвращаемых записей. Чтобы получить больше или меньше результатов, можно переопределить страницы quickbase по умолчанию. Если запрошенное значение здесь превышает динамические максимумы, мы вернем подмножество результатов, а остальные можно собрать в последующих вызовах API.
			object
Идентификатор отчета	reportId	True	string	Идентификатор отчета, уникальный для таблицы.

Возвращаемое значение

Запуск ответа отчета

runReportResponse

Выполнение формулы

Идентификатор операции:

RunFormula

Позволяет выполнять формулу с помощью вызова API. Используйте этот метод в пользовательском коде, чтобы получить значение обратно формулы без дискретного поля в записи.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
формула	formula	True	string	Формула для выполнения. Это должна быть допустимая формула Quickbase.
избавлять	rid		integer	Идентификатор записи для запуска формулы. Требуется только для формул, выполняемых в контексте записи. Например, в формуле User() не требуется идентификатор записи.
от / из / с (context-dependent)	from	True	string	Уникальный идентификатор (dbid) таблицы.

Возвращаемое значение

Выполнение ответа формулы

runFormulaResponse

Запрос данных

Идентификатор операции:

RunQuery

Передайте запрос на языке запросов Quickbase. Возвращает данные записи с интеллектуальной разбивкой на страницы на основе приблизительного размера каждой записи. Объект метаданных будет содержать необходимые сведения для итерации ответа и сбора дополнительных данных.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
skip	skip		integer	Количество пропускаемых записей.
compareWithAppLocalTime	compareWithAppLocalTime		boolean	Следует ли выполнять запрос к полю даты и времени в отношении локального времени приложения. Запрос выполняется по умолчанию в формате UTC.
top	top		integer	Максимальное количество отображаемых записей.
where	where		string	Фильтр с помощью языка запросов Quickbase, который определяет возвращаемые записи. Если этот параметр опущен, запрос вернет все записи.
fieldId	fieldId		integer	Уникальный идентификатор поля в таблице.
Grouping	grouping		string	Группировать по возрастанию (ASC), убыванию (DESC) или равным значениям (равным значениям)
sortBy	sortBy		object	По умолчанию запросы будут отсортированы по заданным полям сортировки или сортировке по умолчанию, если запрос не предоставляет никаких. Установите значение false, чтобы избежать сортировки, если порядок возвращаемых данных не важен. Возврат данных без сортировки может повысить производительность.
select	select		object
от / из / с (context-dependent)	from	True	string	Идентификатор таблицы.

Возвращаемое значение

Выполнение ответа запроса

runQueryResponse

Клонирование маркера пользователя

Идентификатор операции:

CloneUserToken

Клонирует маркер пользователя, прошедший проверку подлинности. Все приложения, связанные с этим маркером, автоматически связываются с новым маркером.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
имя	name		string	Новое имя клонированного маркера пользователя.
описание	description		string	Описание клонированного маркера пользователя.

Возвращаемое значение

Клонирование ответа маркера пользователя

cloneUserTokenResponse

Копирование приложения

Идентификатор операции:

CopyApp

Копирует указанное приложение. Новое приложение будет иметь ту же схему, что и исходная. Дополнительные параметры копирования см. ниже.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
имя	name	True	string	Имя только что скопированного приложения
описание	description		string	Описание только что скопированного приложения
assignUserToken	assignUserToken		boolean	Добавление маркера пользователя, используемого для выполнения этого запроса в новое приложение
excludeFiles	excludeFiles		boolean	Если значение keepData имеет значение true, следует ли копировать также вложения файлов. Если значение keepData равно false, это свойство игнорируется
keepData	keepData		boolean	Копирование данных приложения вместе со схемой
usersAndRoles	usersAndRoles		boolean	Если значение true, пользователи будут скопированы вместе с назначенными ролями. Если значение false, пользователи и роли будут скопированы, но роли не будут назначены
ИД приложения	appId	True	string	Уникальный идентификатор приложения.

Возвращаемое значение

Копирование ответа приложения

copyAppResponse

Обновление поля

Идентификатор операции:

UpdateField

Обновляет свойства и пользовательские разрешения поля. Попытка обновить определенные свойства может привести к тому, что существующие данные больше не подчиняются новым свойствам поля и могут быть отклонены. См. описание обязательных, уникальных и вариантов, приведенных ниже, для конкретных ситуаций. Все свойства поля, которое не указано в тексте запроса, останутся неизменными.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Код(ID) таблицы	tableId	True	string	Уникальный идентификатор таблицы.
Аудит	audited		boolean	Указывает, отслеживается ли поле в рамках журналов аудита quickbase. Это свойство можно задать только значение true, если в приложении включены журналы аудита. См. раздел "Включить журналы изменений данных" в журналах аудита quickbase.
fieldHelp	fieldHelp		string	Настроенный текст справки, отображаемый пользователям в продукте.
bold	bold		boolean	Указывает, настроено ли поле для отображения полужирным шрифтом в продукте.
required	required		boolean	Указывает, является ли поле обязательным (т. е. если каждая запись должна иметь ненулевое значение в этом поле). Если вы попытаетесь изменить поле с не обязательного на обязательное, а таблица в настоящее время содержит записи с пустыми значениями в этом поле, вы получите сообщение об ошибке, указывающее, что в поле есть значения NULL. В этом случае необходимо найти и обновить эти записи с пустыми значениями поля перед изменением поля на обязательное.
comments	comments		string	Примечания, введенные в свойства поля администратором.
doesTotal	doesTotal		boolean	Будет ли это поле итогом в отчетах в продукте.
автосохранение	autoSave		boolean	Будет ли поле ссылки автоматически сохраняться.
defaultValueLuid	defaultValueLuid		integer	Значение идентификатора пользователя по умолчанию.
maxVersions	maxVersions		integer	Максимальное количество версий, настроенных для вложения файла.
format	format		integer	Формат для отображения времени.
carryChoices	carryChoices		boolean	Следует ли копировать поле с несколькими полями выбора.
максимальная длина	maxLength		integer	Максимальное количество символов, разрешенных для записи в Quickbase для этого поля.
linkText	linkText		string	Настроенное текстовое значение, которое заменяет URL-адрес, который пользователи видят в продукте.
parentFieldId	parentFieldId		integer	Идентификатор родительского составного поля, если применимо.
displayTimezone	displayTimezone		boolean	Указывает, следует ли отображать часовой пояс в продукте.
summaryTargetFieldId	summaryTargetFieldId		integer	Идентификатор поля, используемого для агрегирования значений из дочернего элемента, если применимо. Отображается значение 0, если сводная функция не требует выбора поля (например, счетчика).
allowNewChoices	allowNewChoices		boolean	Указывает, могут ли пользователи добавлять новые варианты в список выбора.
defaultToday	defaultToday		boolean	Указывает, используется ли значение поля по умолчанию для новых записей.
Единиц	units		string	Метка единиц.
lookupTargetFieldId	lookupTargetFieldId		integer	Идентификатор поля, которое является целевым объектом родительской таблицы для этого подстановки.
СводкаFunction3	summaryFunction		string	Тип накопления для поля сводки.
sourceFieldId	sourceFieldId		integer	Идентификатор исходного поля.
doesAverage	doesAverage		boolean	Значение этого поля в отчетах в продукте.
формула	formula		string	Формула поля, настроенная в Quickbase.
decimalPlaces	decimalPlaces		integer	Число десятичных разрядов, отображаемых в продукте для этого поля.
displayMonth	displayMonth		string	Отображение месяцев.
seeVersions	seeVersions		boolean	Указывает, может ли пользователь видеть другие версии, помимо последних, вложений в файл в продукте.
numLines	numLines		integer	Количество строк, отображаемых в Quickbase для этого текстового поля.
defaultKind	defaultKind		string	Тип пользователя по умолчанию.
displayEmail	displayEmail		string	Отображение сообщения электронной почты.
coverText	coverText		string	Альтернативный понятный текст, который можно использовать для отображения ссылки в браузере.
currencySymbol	currencySymbol		string	Текущий символ, используемый при отображении значений полей в продукте.
summaryQuery	summaryQuery		string	Сводный запрос.
targetFieldId	targetFieldId		integer	Идентификатор целевого поля.
displayUser	displayUser		string	Настроенный параметр для отображения пользователей в продукте.
blankIsZero	blankIsZero		boolean	Считается ли пустое значение таким же, как 0 в вычислениях в продукте.
точный	exact		boolean	Требуется ли точное совпадение для ссылки отчета.
DefaultDomain	defaultDomain		string	Домен электронной почты по умолчанию.
defaultValue	defaultValue		string	Значение по умолчанию, настроенное для поля при добавлении новой записи.
сокращать	abbreviate		boolean	Не отображайте протокол URL-адреса при отображении URL-адреса.
форматЧисла	numberFormat		integer	Формат, используемый для отображения числовых значений в продукте (десятичные, разделители, группа цифр).
targetTableName	targetTableName		string	Имя целевой таблицы поля.
отображается	appearsAs		string	Текст ссылки, если пустой, URL-адрес будет использоваться в качестве текста ссылки.
Ширина	width		integer	Ширина входных данных поля в продукте.
CurrencyFormat	currencyFormat		string	Формат валюты, используемый при отображении значений полей в продукте.
displayImages	displayImages		boolean	Указывает, будут ли изображения отображаться для вложений файлов в формах и отчетах в продукте.
displayDayOfWeek	displayDayOfWeek		boolean	Указывает, следует ли отображать день недели в продукте.
summaryReferenceFieldId	summaryReferenceFieldId		integer	Идентификатор поля, которое является ссылкой в связи для этой сводки.
запятаяStart	commaStart		integer	Количество цифр перед отображением запятых в продукте при необходимости.
choices	choices		array of string	Массив записей, которые существуют для поля, которое предлагает пользователю выбор. Обратите внимание, что эти варианты ссылаются на допустимые значения всех записей, добавленных в будущем. Вы можете удалить значения из списка вариантов, даже если существуют записи с этими значениями в этом поле. Они будут отображаться красным цветом, когда пользователи смотрят на данные в браузере, но нет другого эффекта. При обновлении поля с этим свойством старые варианты удаляются и заменяются новыми вариантами.
targetTableId	targetTableId		string	Идентификатор целевой таблицы.
displayRelative	displayRelative		boolean	Указывает, следует ли отображать время как относительное.
составные поля	compositeFields		object
summaryTableId	summaryTableId		string	Таблица с полями сводки ссылается на поля из.
displayTime	displayTime		boolean	Указывает, следует ли отображать время в дополнение к дате.
VersionMode	versionMode		string	Режимы версий для файлов. Сохраните все версии и сохраните последнюю версию.
snapFieldId	snapFieldId		integer	Идентификатор поля, используемого для значений моментального снимка при необходимости.
часы24	hours24		boolean	Указывает, следует ли отображать время в формате 24 часа в продукте.
sortAlpha	sortAlpha		boolean	Следует ли отсортировать по алфавиту, сортировка по умолчанию — по идентификатору записи.
sortAsGiven	sortAsGiven		boolean	Указывает, сортируются ли перечисленные записи в алфавитном порядке.
hasExtension	hasExtension		boolean	Имеет ли это поле расширение телефона.
useNewWindow	useNewWindow		boolean	Указывает, должен ли URL-адрес открыть новое окно, когда пользователь щелкает его в продукте.
appendOnly	appendOnly		boolean	Указывает, является ли это поле только добавлением.
displayAsLink	displayAsLink		boolean	Указывает, должно ли поле, являющееся частью связи, отображаться как гиперссылка на родительскую запись в продукте.
lookupReferenceFieldId	lookupReferenceFieldId		integer	Идентификатор поля, которое является ссылкой в связи для этого поиска.
отображаетсяByDefault	appearsByDefault		boolean	Указывает, помечено ли поле как значение по умолчанию в отчетах.
уникальный	unique		boolean	Указывает, должна ли каждая запись в таблице содержать уникальное значение этого поля. Если вы попытаетесь изменить поле с не уникальным на уникальный, а таблица в настоящее время содержит записи с тем же значением этого поля, вы получите ошибку. В этом случае необходимо найти и обновить эти записи с повторяющимися значениями поля перед изменением поля на уникальное.
роль	role		string	Роль, связанная с заданным разрешением для поля
permissionType	permissionType		string	Разрешение, предоставленное роли для этого поля
roleId	roleId		integer	Идентификатор заданной роли
addToForms	addToForms		boolean	Должно ли добавиться поле в формах.
label	label		string	Метка (имя) поля.
findEnabled	findEnabled		boolean	Указывает, помечено ли поле как доступное для поиска.
noWrap	noWrap		boolean	Указывает, настроено ли поле не упаковывать при отображении в продукте.
ИД поля	fieldId	True	integer	Уникальный идентификатор (FID) поля.

Возвращаемое значение

Обновление ответа поля

updateFieldResponse

Обновление приложения

Идентификатор операции:

UpdateApp

Обновляет основные свойства и (или) переменные приложения для конкретного приложения. Все свойства приложения, которое не указано в тексте запроса, останутся неизменными.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
имя	name	True	string	Имя переменной.
value	value	True	string	Значение переменной.
имя	name		string	Имя приложения.
описание	description		string	Описание приложения.
ИД приложения	appId	True	string	Уникальный идентификатор приложения.

Возвращаемое значение

Обновление ответа приложения

updateAppResponse

Обновление связи

Идентификатор операции:

UpdateRelationship

Используйте эту конечную точку для добавления полей подстановки и полей сводки в существующую связь. Обновление связи не приведет к удалению существующих полей подстановки и сводки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
summaryFid	summaryFid		double	Идентификатор поля для суммировки.
label	label		string	Метка для поля сводки.
Накопительный тип	accumulationType	True	string	Тип накопления для поля сводки.
where	where		string	Фильтр с помощью языка запросов Quickbase, который определяет возвращаемые записи.
lookupFieldIds	lookupFieldIds		array of integer	Массив идентификаторов полей родительской таблицы, который станет полями подстановки в дочерней таблице.
Код(ID) таблицы	tableId	True	string	Уникальный идентификатор (DBID) таблицы. Это будет дочерняя таблица.
Идентификатор связи	relationshipId	True	double	Идентификатор связи. Это идентификатор поля ссылки в дочерней таблице.

Возвращаемое значение

Обновление ответа связи

updateRelationshipResponse

Обновление таблицы

Идентификатор операции:

UpdateTable

Обновляет основные свойства определенной таблицы. Все свойства таблицы, которая не указана в тексте запроса, останутся неизменными.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
ИД приложения	appId	True	string	Уникальный идентификатор приложения
имя	name		string	Имя таблицы.
pluralRecordName	pluralRecordName		string	Число существительных для записей в таблице. Если это значение не передается, значение по умолчанию — Records.
singleRecordName	singleRecordName		string	Единственное существительное для записей в таблице. Если это значение не передается, значение по умолчанию — Record.
описание	description		string	Описание таблицы. Если это значение не передается, значение по умолчанию пусто.
Код(ID) таблицы	tableId	True	string	Уникальный идентификатор (DBID) таблицы.

Возвращаемое значение

Обновление ответа таблицы

updateTableResponse

Отключение маркера пользователя

Идентификатор операции:

DeactivateUserToken

Деактивирует маркер пользователя, прошедший проверку подлинности. После этого маркер пользователя должен быть повторно активирован в пользовательском интерфейсе.

Возвращаемое значение

Имя	Путь	Тип	Описание
id	id	integer	id

Получение временного маркера для DBID

Идентификатор операции:

GetTempTokenDBID

Используйте эту конечную точку для получения временного маркера авторизации в пределах приложения или таблицы. Затем этот маркер можно использовать для выполнения других вызовов API (см. авторизацию). Срок действия этого маркера истекает через 5 минут.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Маркер приложения	QB-App-Token		string	Маркер приложения Quickbase
DBID	dbid	True	string	Уникальный идентификатор приложения или таблицы.

Возвращаемое значение

getTempTokenDBIDResponse

getTempTokenDBIDResponse

Получение всех отчетов таблицы

Идентификатор операции:

GetTableReports

Получение схемы (свойств) всех отчетов для таблицы. Если пользователь, выполняющий API, является администратором приложения, API также вернет все личные отчеты с идентификатором пользователя владельца.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Код(ID) таблицы	tableId	True	string	Уникальный идентификатор таблицы.

Возвращаемое значение

Имя	Путь	Тип	Описание
		array of object
Идентификатор	id	string	Идентификатор.
Имя	name	string	Имя.
Тип	type	string	Тип.
Description	description	string	Описание.
Идентификатор ответственного	ownerId	string	Идентификатор владельца.
Используется последний	usedLast	string	Когда используется последний.
Используемое число	usedCount	integer	Используемое число.

Получение всех связей

Идентификатор операции:

GetRelationships

Получение списка всех связей и их определений для определенной таблицы. Сведения предоставляются как для родительских, так и дочерних сторон отношений в данном приложении. Ограниченные сведения возвращаются для связей между приложениями.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Пропустить	skip		integer	Количество связей, которые нужно пропустить.
Код(ID) таблицы	tableId	True	string	Уникальный идентификатор (DBID) таблицы.

Возвращаемое значение

Получение ответа на связи

getRelationshipsResponse

Получение использования для всех полей

Идентификатор операции:

GetFieldsUsage

Получение всей статистики использования полей для таблицы. Это сводка сведений, которые можно найти в таблице использования свойств поля.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Код(ID) таблицы	tableId	True	string	Уникальный идентификатор (DBID) таблицы.
Пропустить	skip		integer	Количество полей, которые нужно пропустить из списка.
Верх	top		integer	Максимальное количество возвращаемых полей.

Возвращаемое значение

Имя	Путь	Тип	Описание
		array of object
Идентификатор	field.id	integer	Идентификатор.
Имя	field.name	string	Имя.
Тип	field.type	string	Тип.
Численность	usage.actions.count	integer	Количество.
Численность	usage.appHomePages.count	integer	Количество.
Численность	usage.defaultReports.count	integer	Количество.
Численность	usage.exactForms.count	integer	Количество.
Численность	usage.fields.count	integer	Количество.
Численность	usage.forms.count	integer	Количество.
Численность	usage.notifications.count	integer	Количество.
Численность	usage.personalReports.count	integer	Количество.
Численность	usage.relationships.count	integer	Количество.
Численность	usage.reminders.count	integer	Количество.
Численность	usage.reports.count	integer	Количество.
Численность	usage.roles.count	integer	Количество.
Численность	usage.webhooks.count	integer	Количество.

Получение использования поля

Идентификатор операции:

GetFieldUsage

Получение статистики использования отдельных полей. Это сводка сведений, которые можно найти в таблице использования свойств поля.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Код(ID) таблицы	tableId	True	string	Уникальный идентификатор (DBID) таблицы.
ИД поля	fieldId	True	integer	Уникальный идентификатор (FID) поля.

Возвращаемое значение

Имя	Путь	Тип	Описание
		array of object
Идентификатор	field.id	integer	Идентификатор.
Имя	field.name	string	Имя.
Тип	field.type	string	Тип.
Численность	usage.actions.count	integer	Количество.
Численность	usage.appHomePages.count	integer	Количество.
Численность	usage.defaultReports.count	integer	Количество.
Численность	usage.exactForms.count	integer	Количество.
Численность	usage.fields.count	integer	Количество.
Численность	usage.forms.count	integer	Количество.
Численность	usage.notifications.count	integer	Количество.
Численность	usage.personalReports.count	integer	Количество.
Численность	usage.relationships.count	integer	Количество.
Численность	usage.reminders.count	integer	Количество.
Численность	usage.reports.count	integer	Количество.
Численность	usage.roles.count	integer	Количество.
Численность	usage.webhooks.count	integer	Количество.

Получение отчета

Идентификатор операции:

GetReport

Получение схемы (свойств) отдельного отчета.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Код(ID) таблицы	tableId	True	string	Уникальный идентификатор таблицы.
Идентификатор отчета	reportId	True	string	Идентификатор отчета, уникальный для таблицы.

Возвращаемое значение

Получение ответа отчета

getReportResponse

Получение полей для таблицы

Идентификатор операции:

GetFields

Возвращает свойства для всех полей в определенной таблице. Свойства для каждого поля совпадают с свойствами в поле Get.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Код(ID) таблицы	tableId	True	string	Уникальный идентификатор (DBID) таблицы.
Включение разрешений поля	includeFieldPerms		boolean	Установите значение true, если вы хотите вернуть пользовательские разрешения для полей.

Возвращаемое значение

Имя	Путь	Тип	Описание
		array of object
Идентификатор	id	integer	Идентификатор.
Этикетка	label	string	Метка.
Тип поля	fieldType	string	Тип поля.
Нет оболочки	noWrap	boolean	Нет ли обертывания.
Bold	bold	boolean	Будь то полужирным.
Обязательно	required	boolean	Требуется ли это.
Отображается по умолчанию	appearsByDefault	boolean	Отображается ли по умолчанию.
Поиск включен	findEnabled	boolean	Включена ли функция поиска.
Уникальный	unique	boolean	Является ли уникальным.
Выполняет копирование данных	doesDataCopy	boolean	Выполняется ли копирование данных.
Справка по полю	fieldHelp	string	Справка по полю.
Аудит	audited	boolean	Проверяется ли аудит.
Первичный ключ	properties.primaryKey	boolean	Указывает, является ли первичный ключ.
Внешний ключ	properties.foreignKey	boolean	Указывает, является ли внешний ключ.
Числовые линии	properties.numLines	integer	Количество строк.
Максимальная длина	properties.maxLength	integer	Максимальная длина.
Только добавление	properties.appendOnly	boolean	Указывает, только ли добавление.
allowHTML	properties.allowHTML	boolean	Следует ли разрешать HTML.
Сортировка как заданная	properties.sortAsGiven	boolean	Независимо от того, задано ли сортировка.
Варианты переноса	properties.carryChoices	boolean	Следует ли нести выбор.
Разрешить новые варианты	properties.allowNewChoices	boolean	Следует ли разрешать новые варианты.
Formula	properties.formula	string	Формула.
Значение по умолчанию	properties.defaultValue	string	Значение по умолчанию.
Форматирование чисел	properties.numberFormat	integer	Формат числа.
Десятичные разряды	properties.decimalPlaces	integer	Десятичные разряды.
Выполняет среднее значение	properties.doesAverage	boolean	Имеет ли среднее значение.
Общее число	properties.doesTotal	boolean	Имеет ли общий итог.
Пустое значение равно нулю	properties.blankIsZero	boolean	Значение "Пустое" равно нулю.
Permissions	permissions	array of object
Тип разрешения	permissions.permissionType	string	Тип разрешения.
Role	permissions.role	string	Роль.
Идентификатор роли	permissions.roleId	integer	Идентификатор роли.
Добавление в формы	addToForms	boolean	Следует ли добавлять в формы.

Получение поля

Идентификатор операции:

GetField

Возвращает свойства отдельного поля на основе идентификатора поля.
Свойства, присутствующих во всех типах полей, возвращаются на верхнем уровне. Свойства, уникальные для определенного типа поля, возвращаются в атрибуте properties. Дополнительные сведения о свойствах каждого типа поля см. на странице типов полей.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Код(ID) таблицы	tableId	True	string	Уникальный идентификатор (DBID) таблицы.
Включение разрешений поля	includeFieldPerms		boolean	Установите значение true, если вы хотите вернуть пользовательские разрешения для полей.
ИД поля	fieldId	True	integer	Уникальный идентификатор (FID) поля.

Возвращаемое значение

Получение ответа поля

getFieldResponse

Получение приложения

Идентификатор операции:

GetApp

Возвращает основные свойства приложения, включая переменные приложения.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
ИД приложения	appId	True	string	Уникальный идентификатор приложения.

Возвращаемое значение

Получение ответа приложения

getAppResponse

Получение событий приложения

Идентификатор операции:

GetAppEvents

Получите список событий, которые могут быть активированы на основе данных или действий пользователей в этом приложении, включает в себя: уведомление по электронной почте, напоминания, подписки, действия QB, веб-перехватчики, триггеры изменений записи (не включают запланированные).

Параметры

Имя	Ключ	Обязательно	Тип	Описание
ИД приложения	appId	True	string	Уникальный идентификатор приложения.

Возвращаемое значение

Имя	Путь	Тип	Описание
		array of object
Тип	type	string	Тип.
Адрес электронной почты	owner.email	string	Адрес электронной почты владельца.
Идентификатор	owner.id	string	Идентификатор владельца.
Имя	owner.name	string	Имя владельца.
Имя пользователя	owner.userName	string	Имя пользователя владельца.
Активен	isActive	boolean	Является ли активным.
Код(ID) таблицы	tableId	string	Идентификатор таблицы.
Имя	name	string	Имя.
URL	url	string	URL-адрес.

Получение таблиц для приложения

Идентификатор операции:

GetAppTables

Возвращает список всех таблиц, существующих в определенном приложении. Свойства для каждой таблицы совпадают с тем, что возвращается в таблице Get.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
ИД приложения	appId	True	string	Уникальный идентификатор приложения

Возвращаемое значение

Имя	Путь	Тип	Описание
		array of object
Имя	name	string	Имя.
Создано	created	string	При создании.
Updated	updated	string	При обновлении.
Псевдоним	alias	string	Псевдоним.
Description	description	string	Описание.
Идентификатор	id	string	Идентификатор.
Следующий идентификатор записи	nextRecordId	integer	Идентификатор следующей записи.
Идентификатор следующего поля	nextFieldId	integer	Идентификатор следующего поля.
Идентификатор поля сортировки по умолчанию	defaultSortFieldId	integer	Идентификатор поля сортировки по умолчанию.
Порядок сортировки по умолчанию	defaultSortOrder	string	Порядок сортировки по умолчанию.
Идентификатор поля ключа	keyFieldId	integer	Идентификатор поля ключа.
Имя одной записи	singleRecordName	string	Имя одной записи.
Имя записи plural	pluralRecordName	string	Имя записи множественного числа.
Ограничение размера	sizeLimit	string	Ограничение размера.
Используемое пространство	spaceUsed	string	Используемое пространство.
Оставшееся пространство	spaceRemaining	string	Оставшееся пространство.

Получение таблицы

Идентификатор операции:

GetTable

Возвращает свойства отдельной таблицы, которая является частью приложения.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
ИД приложения	appId	True	string	Уникальный идентификатор приложения
Код(ID) таблицы	tableId	True	string	Уникальный идентификатор (DBID) таблицы.

Возвращаемое значение

Получение ответа на таблицу

getTableResponse

Скачивание вложения

Идентификатор операции:

DownloadFile

Загружает вложение файла с содержимым вложения файла, закодированного в формате base64. Ответ API возвращает имя файла в заголовке Content-Disposition . Метаданные о файлах можно получить из конечных точек /records и /reports, где это применимо. Используйте эти конечные точки для получения необходимых сведений для получения файлов.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Код(ID) таблицы	tableId	True	string	Уникальный идентификатор таблицы.
Код записи	recordId	True	integer	Уникальный идентификатор записи.
ИД поля	fieldId	True	integer	Уникальный идентификатор поля.
Номер версии	versionNumber	True	integer	Номер версии вложения файла.

Возвращаемое значение

response

string

Создание поля

Идентификатор операции:

CreateField

Создает поле в таблице, включая пользовательские разрешения этого поля.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Код(ID) таблицы	tableId	True	string	Уникальный идентификатор таблицы.
Аудит	audited		boolean	Указывает, отслеживается ли поле в рамках журналов аудита quickbase. Это свойство можно задать только значение true, если в приложении включены журналы аудита. См. раздел "Включить журналы изменений данных" в журналах аудита quickbase.
fieldHelp	fieldHelp		string	Настроенный текст справки, отображаемый пользователям в продукте.
bold	bold		boolean	Указывает, настроено ли поле для отображения полужирным шрифтом в продукте.
comments	comments		string	Примечания, введенные в свойства поля администратором.
doesTotal	doesTotal		boolean	Будет ли это поле итогом в отчетах в продукте.
автосохранение	autoSave		boolean	Будет ли поле ссылки автоматически сохраняться.
defaultValueLuid	defaultValueLuid		integer	Значение идентификатора пользователя по умолчанию.
maxVersions	maxVersions		integer	Максимальное количество версий, настроенных для вложения файла.
format	format		integer	Формат для отображения времени.
carryChoices	carryChoices		boolean	Следует ли копировать поле с несколькими полями выбора.
максимальная длина	maxLength		integer	Максимальное количество символов, разрешенных для записи в Quickbase для этого поля.
linkText	linkText		string	Настроенное текстовое значение, которое заменяет URL-адрес, который пользователи видят в продукте.
parentFieldId	parentFieldId		integer	Идентификатор родительского составного поля, если применимо.
displayTimezone	displayTimezone		boolean	Указывает, следует ли отображать часовой пояс в продукте.
allowNewChoices	allowNewChoices		boolean	Указывает, могут ли пользователи добавлять новые варианты в список выбора.
defaultToday	defaultToday		boolean	Указывает, используется ли значение поля по умолчанию для новых записей.
Единиц	units		string	Метка единиц.
sourceFieldId	sourceFieldId		integer	Идентификатор исходного поля.
doesAverage	doesAverage		boolean	Значение этого поля в отчетах в продукте.
формула	formula		string	Формула поля, настроенная в Quickbase.
decimalPlaces	decimalPlaces		integer	Число десятичных разрядов, отображаемых в продукте для этого поля.
displayMonth	displayMonth		string	Отображение месяцев.
seeVersions	seeVersions		boolean	Указывает, может ли пользователь видеть другие версии, помимо последних, вложений в файл в продукте.
numLines	numLines		integer	Количество строк, отображаемых в Quickbase для этого текстового поля.
defaultKind	defaultKind		string	Тип пользователя по умолчанию.
displayEmail	displayEmail		string	Отображение сообщения электронной почты.
coverText	coverText		string	Альтернативный понятный текст, который можно использовать для отображения ссылки в браузере.
currencySymbol	currencySymbol		string	Текущий символ, используемый при отображении значений полей в продукте.
targetFieldId	targetFieldId		integer	Идентификатор целевого поля.
displayUser	displayUser		string	Настроенный параметр для отображения пользователей в продукте.
blankIsZero	blankIsZero		boolean	Считается ли пустое значение таким же, как 0 в вычислениях в продукте.
точный	exact		boolean	Требуется ли точное совпадение для ссылки отчета.
DefaultDomain	defaultDomain		string	Домен электронной почты по умолчанию.
defaultValue	defaultValue		string	Значение по умолчанию, настроенное для поля при добавлении новой записи.
сокращать	abbreviate		boolean	Не отображайте протокол URL-адреса при отображении URL-адреса.
форматЧисла	numberFormat		integer	Формат, используемый для отображения числовых значений в продукте (десятичные, разделители, группа цифр).
targetTableName	targetTableName		string	Имя целевой таблицы поля.
отображается	appearsAs		string	Текст ссылки, если пустой, URL-адрес будет использоваться в качестве текста ссылки.
Ширина	width		integer	Ширина входных данных поля в продукте.
CurrencyFormat	currencyFormat		string	Формат валюты, используемый при отображении значений полей в продукте.
displayImages	displayImages		boolean	Указывает, будут ли изображения отображаться для вложений файлов в формах и отчетах в продукте.
displayDayOfWeek	displayDayOfWeek		boolean	Указывает, следует ли отображать день недели в продукте.
запятаяStart	commaStart		integer	Количество цифр перед отображением запятых в продукте при необходимости.
choices	choices		array of string	Массив записей, которые существуют для поля, которое предлагает пользователю выбор. Обратите внимание, что эти варианты ссылаются на допустимые значения всех записей, добавленных в будущем. Вы можете удалить значения из списка вариантов, даже если существуют записи с этими значениями в этом поле. Они будут отображаться красным цветом, когда пользователи смотрят на данные в браузере, но нет другого эффекта. При обновлении поля с этим свойством старые варианты удаляются и заменяются новыми вариантами.
targetTableId	targetTableId		string	Идентификатор целевой таблицы.
displayRelative	displayRelative		boolean	Указывает, следует ли отображать время как относительное.
составные поля	compositeFields		object
displayTime	displayTime		boolean	Указывает, следует ли отображать время в дополнение к дате.
VersionMode	versionMode		string	Режимы версий для файлов. Сохраните все версии и сохраните последнюю версию.
snapFieldId	snapFieldId		integer	Идентификатор поля, используемого для значений моментального снимка при необходимости.
часы24	hours24		boolean	Указывает, следует ли отображать время в формате 24 часа в продукте.
sortAlpha	sortAlpha		boolean	Следует ли отсортировать по алфавиту, сортировка по умолчанию — по идентификатору записи.
sortAsGiven	sortAsGiven		boolean	Указывает, сортируются ли перечисленные записи в алфавитном порядке.
hasExtension	hasExtension		boolean	Имеет ли это поле расширение телефона.
useNewWindow	useNewWindow		boolean	Указывает, должен ли URL-адрес открыть новое окно, когда пользователь щелкает его в продукте.
appendOnly	appendOnly		boolean	Указывает, является ли это поле только добавлением.
displayAsLink	displayAsLink		boolean	Указывает, должно ли поле, являющееся частью связи, отображаться как гиперссылка на родительскую запись в продукте.
отображаетсяByDefault	appearsByDefault		boolean	Указывает, помечено ли поле как значение по умолчанию в отчетах.
FieldType2	fieldType	True	string	Типы полей щелкните любую из ссылок типа поля для получения дополнительных сведений.
роль	role		string	Роль, связанная с заданным разрешением для поля
permissionType	permissionType		string	Разрешение, предоставленное роли для этого поля
roleId	roleId		integer	Идентификатор заданной роли
addToForms	addToForms		boolean	Должно ли добавиться поле в формах.
label	label	True	string	Метка (имя) поля.
findEnabled	findEnabled		boolean	Указывает, помечено ли поле как доступное для поиска.
noWrap	noWrap		boolean	Указывает, настроено ли поле не упаковывать при отображении в продукте.

Возвращаемое значение

Создание ответа поля

createFieldResponse

Создание связи

Идентификатор операции:

CreateRelationship

Создает связь в таблице, а также поля подстановки и сводки. Связи можно создавать только для таблиц в одном приложении.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
summaryFid	summaryFid		double	Идентификатор поля для суммировки.
label	label		string	Метка для поля сводки.
Накопительный тип	accumulationType	True	string	Тип накопления для поля сводки.
where	where		string	Фильтр с помощью языка запросов Quickbase, который определяет возвращаемые записи.
lookupFieldIds	lookupFieldIds		array of integer	Массив идентификаторов полей в родительской таблице, которые становятся полями подстановки в дочерней таблице.
parentTableId	parentTableId	True	string	Идентификатор родительской таблицы для связи.
label	label		string	Метка для поля внешнего ключа.
Код(ID) таблицы	tableId	True	string	Уникальный идентификатор (DBID) таблицы. Это будет дочерняя таблица.

Возвращаемое значение

Создание ответа связи

createRelationshipResponse

Создание таблицы

Идентификатор операции:

CreateTable

Создает таблицу в приложении.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
ИД приложения	appId	True	string	Уникальный идентификатор приложения
имя	name	True	string	Имя таблицы.
pluralRecordName	pluralRecordName		string	Число существительных для записей в таблице. Если это значение не передается, значение по умолчанию — Records.
singleRecordName	singleRecordName		string	Единственное существительное для записей в таблице. Если это значение не передается, значение по умолчанию — Record.
описание	description		string	Описание таблицы. Если это значение не передается, значение по умолчанию пусто.

Возвращаемое значение

Создание ответа таблицы

createTableResponse

Создать приложение

Идентификатор операции:

CreateApp

Создает приложение в учетной записи. У вас должны быть права на создание приложения в соответствующей учетной записи. Основные свойства и переменные приложения можно задать с помощью этого API.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
assignToken	assignToken		boolean	Задайте значение true, если вы хотите назначить приложению маркер пользователя, который использовался для создания приложения. Значение по умолчанию — false.
имя	name	True	string	Имя переменной.
value	value	True	string	Значение переменной.
имя	name	True	string	Имя приложения. Вы можете создавать несколько приложений с одинаковым именем в одной области, так как они будут иметь разные значения dbid. Мы призываем вас быть осторожными в этом.
описание	description		string	Описание приложения. Если это свойство не осталось, описание приложения будет пустым.

Возвращаемое значение

Создание ответа приложения

createAppResponse

Удаление вложения

Идентификатор операции:

DeleteFile

Удаляет одну версию вложения файла. Метаданные о файлах можно получить из конечных точек /records и /reports, где это применимо. Используйте эти конечные точки, чтобы получить необходимые сведения для удаления версий файлов.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Код(ID) таблицы	tableId	True	string	Уникальный идентификатор таблицы.
Код записи	recordId	True	integer	Уникальный идентификатор записи.
ИД поля	fieldId	True	integer	Уникальный идентификатор поля.
Номер версии	versionNumber	True	integer	Номер версии вложения файла.

Возвращаемое значение

Удаление ответа на файл

deleteFileResponse

Удаление записей

Идентификатор операции:

DeleteRecords

Удаляет записи в таблице на основе запроса. Кроме того, можно удалить все записи в таблице.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
от / из / с (context-dependent)	from	True	string	Уникальный идентификатор таблицы.
where	where	True	string	Фильтр для удаления записей. Чтобы удалить все записи, укажите фильтр, который будет содержать все записи, например {3.GT.0}, где 3 — это идентификатор поля идентификатора записи.

Возвращаемое значение

Удаление ответа записей

deleteRecordsResponse

Удаление маркера пользователя

Идентификатор операции:

DeleteUserToken

Удаляет маркер пользователя, прошедший проверку подлинности. Это не является обратимым.

Возвращаемое значение

Удаление ответа маркера пользователя

deleteUserTokenResponse

Удаление полей

Идентификатор операции:

DeleteFields

Удаляет одно или несколько полей в таблице на основе идентификатора поля. Это также будет окончательно удалять любые данные или вычисления в этом поле.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Код(ID) таблицы	tableId	True	string	Уникальный идентификатор таблицы.
fieldIds	fieldIds	True	array of integer	Список идентификаторов полей для удаления.

Возвращаемое значение

Удаление ответа полей

deleteFieldsResponse

Удаление приложения

Идентификатор операции:

DeleteApp

Удаляет все приложение, включая все таблицы и данные.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
имя	name	True	string	Чтобы подтвердить удаление приложения, мы просим указать имя приложения.
ИД приложения	appId	True	string	Уникальный идентификатор приложения.

Возвращаемое значение

Удаление ответа приложения

deleteAppResponse

Удаление связи

Идентификатор операции:

DeleteRelationship

Используйте эту конечную точку для удаления всей связи, включая все поля подстановки и сводки. Поле ссылки в связи не будет удалено.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Код(ID) таблицы	tableId	True	string	Уникальный идентификатор (DBID) таблицы. Это будет дочерняя таблица.
Идентификатор связи	relationshipId	True	double	Идентификатор связи. Это идентификатор поля ссылки в дочерней таблице.

Возвращаемое значение

Удаление ответа связи

deleteRelationshipResponse

Удалить таблицу

Идентификатор операции:

DeleteTable

Удаляет определенную таблицу в приложении, включая все данные в нем.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
ИД приложения	appId	True	string	Уникальный идентификатор приложения
Код(ID) таблицы	tableId	True	string	Уникальный идентификатор (DBID) таблицы.

Возвращаемое значение

Удаление ответа таблицы

deleteTableResponse

Определения

createAppResponse

Имя	Путь	Тип	Описание
имя	name	string	Имя приложения. Вы можете создавать несколько приложений с одинаковым именем в одной области, так как они будут иметь разные значения dbid. Мы призываем вас быть осторожными в этом.
описание	description	string	Описание приложения. Если это свойство не осталось, описание приложения будет пустым.
создано	created	string	Время и дата создания приложения в формате ВРЕМЕНИ ISO 8601 ггГГ-ММ-DDThh:mm:ss.sssZ (в часовом поясе UTC).
Обновлено	updated	string	Время и дата последнего обновления приложения в формате ВРЕМЕНИ ISO 8601 ггГГ-ММ-DDThh:mm:ss.sssZ (в часовом поясе UTC).
dateFormat	dateFormat	string	Описание формата, используемого при отображении значений даты в этом приложении. Обратите внимание, что это параметр, доступный только в браузере, см. страницу сведений о типе поля в руководстве по API о том, как значения времени возвращаются в вызовах API. Сведения о локализации дат , чтобы задать формат даты приложения.
часовой пояс	timeZone	string	Описание часового пояса, используемого при отображении значений времени в этом приложении. Обратите внимание, что это параметр, доступный только в браузере, см. страницу сведений о типе поля на портале, чтобы узнать, как значения времени возвращаются в вызовах API. См . раздел "Задать часовой пояс" для приложения и учетной записи, чтобы задать часовой пояс приложения.
id	id	string	Уникальный идентификатор для этого приложения.
hasEveryoneOnTheInternet	hasEveryoneOnTheInternet	boolean	Указывает, включает ли приложение все пользователи в Интернете. См. раздел "Общий доступ к приложениям" для всех пользователей в Интернете (EOTI).
variables	variables	array of Variable1	Переменные приложения. См . сведения о переменных приложения
dataClassification	dataClassification	string	Метка классификации данных, назначенная приложению. Если классификация данных не включена, это не будет возвращено. Если классификация данных включена, но приложение не помечено, мы возвращаем значение None. Метки классификации данных можно добавить в консоль администрирования администратором области для планов Platform+.

Переменная1

Имя	Путь	Тип	Описание
имя	name	string	Имя переменной.
value	value	string	Значение переменной.

getAppResponse

Имя	Путь	Тип	Описание
имя	name	string	Имя приложения. Вы можете создавать несколько приложений с одинаковым именем в одной области, так как они будут иметь разные значения dbid. Мы призываем вас быть осторожными в этом.
описание	description	string	Описание приложения. Если это свойство не осталось, описание приложения будет пустым.
создано	created	string	Время и дата создания приложения в формате ВРЕМЕНИ ISO 8601 ггГГ-ММ-DDThh:mm:ss.sssZ (в часовом поясе UTC).
Обновлено	updated	string	Время и дата последнего обновления приложения в формате ВРЕМЕНИ ISO 8601 ггГГ-ММ-DDThh:mm:ss.sssZ (в часовом поясе UTC).
dateFormat	dateFormat	string	Описание формата, используемого при отображении значений даты в этом приложении. Обратите внимание, что это параметр, доступный только в браузере, см. страницу сведений о типе поля в руководстве по API о том, как значения времени возвращаются в вызовах API. Сведения о локализации дат , чтобы задать формат даты приложения.
часовой пояс	timeZone	string	Описание часового пояса, используемого при отображении значений времени в этом приложении. Обратите внимание, что это параметр, доступный только в браузере, см. страницу сведений о типе поля на портале, чтобы узнать, как значения времени возвращаются в вызовах API. См . раздел "Задать часовой пояс" для приложения и учетной записи, чтобы задать часовой пояс приложения.
id	id	string	Уникальный идентификатор для этого приложения.
hasEveryoneOnTheInternet	hasEveryoneOnTheInternet	boolean	Указывает, включает ли приложение все пользователи в Интернете. См. раздел "Общий доступ к приложениям" для всех пользователей в Интернете (EOTI).
variables	variables	array of Variable1	Переменные приложения. См . сведения о переменных приложения
dataClassification	dataClassification	string	Метка классификации данных, назначенная приложению. Если классификация данных не включена, это не будет возвращено. Если классификация данных включена, но приложение не помечено, мы возвращаем значение None. Метки классификации данных можно добавить в консоль администрирования администратором области для планов Platform+.

updateAppResponse

Имя	Путь	Тип	Описание
имя	name	string	Имя приложения. Вы можете создавать несколько приложений с одинаковым именем в одной области, так как они будут иметь разные значения dbid. Мы призываем вас быть осторожными в этом.
описание	description	string	Описание приложения. Если это свойство не осталось, описание приложения будет пустым.
создано	created	string	Время и дата создания приложения в формате ВРЕМЕНИ ISO 8601 ггГГ-ММ-DDThh:mm:ss.sssZ (в часовом поясе UTC).
Обновлено	updated	string	Время и дата последнего обновления приложения в формате ВРЕМЕНИ ISO 8601 ггГГ-ММ-DDThh:mm:ss.sssZ (в часовом поясе UTC).
dateFormat	dateFormat	string	Описание формата, используемого при отображении значений даты в этом приложении. Обратите внимание, что это параметр, доступный только в браузере, см. страницу сведений о типе поля в руководстве по API о том, как значения времени возвращаются в вызовах API. Сведения о локализации дат , чтобы задать формат даты приложения.
часовой пояс	timeZone	string	Описание часового пояса, используемого при отображении значений времени в этом приложении. Обратите внимание, что это параметр, доступный только в браузере, см. страницу сведений о типе поля на портале, чтобы узнать, как значения времени возвращаются в вызовах API. См . раздел "Задать часовой пояс" для приложения и учетной записи, чтобы задать часовой пояс приложения.
id	id	string	Уникальный идентификатор для этого приложения.
hasEveryoneOnTheInternet	hasEveryoneOnTheInternet	boolean	Указывает, включает ли приложение все пользователи в Интернете. См. раздел "Общий доступ к приложениям" для всех пользователей в Интернете (EOTI).
variables	variables	array of Variable1	Переменные приложения. См . сведения о переменных приложения
dataClassification	dataClassification	string	Метка классификации данных, назначенная приложению. Если классификация данных не включена, это не будет возвращено. Если классификация данных включена, но приложение не помечено, мы возвращаем значение None. Метки классификации данных можно добавить в консоль администрирования администратором области для планов Platform+.

deleteAppResponse

Имя	Путь	Тип	Описание
deletedAppId	deletedAppId	string	Идентификатор удаленного приложения.

copyAppResponse

Имя	Путь	Тип	Описание
имя	name	string	Имя приложения. Вы можете создавать несколько приложений с одинаковым именем в одной области, так как они будут иметь разные значения dbid. Мы призываем вас быть осторожными в этом.
описание	description	string	Описание приложения
создано	created	string	Время и дата создания приложения в формате ВРЕМЕНИ ISO 8601 ггГГ-ММ-DDThh:mm:ss.sssZ (в часовом поясе UTC).
Обновлено	updated	string	Время и дата последнего обновления приложения в формате ВРЕМЕНИ ISO 8601 ггГГ-ММ-DDThh:mm:ss.sssZ (в часовом поясе UTC).
dateFormat	dateFormat	string	Описание формата, используемого при отображении значений даты в этом приложении. Обратите внимание, что это параметр, доступный только в браузере, см. страницу сведений о типе поля в руководстве по API о том, как значения времени возвращаются в вызовах API. Сведения о локализации дат , чтобы задать формат даты приложения.
часовой пояс	timeZone	string	Описание часового пояса, используемого при отображении значений времени в этом приложении. Обратите внимание, что это параметр, доступный только в браузере, см. страницу сведений о типе поля на портале, чтобы узнать, как значения времени возвращаются в вызовах API. См . раздел "Задать часовой пояс" для приложения и учетной записи, чтобы задать часовой пояс приложения.
id	id	string	Уникальный идентификатор для этого приложения.
hasEveryoneOnTheInternet	hasEveryoneOnTheInternet	boolean	Указывает, включает ли приложение все пользователи в Интернете. См. раздел "Общий доступ к приложениям" для всех пользователей в Интернете (EOTI).
variables	variables	array of Variable1	Переменные приложения. См . сведения о переменных приложения
ancestorId	ancestorId	string	Идентификатор приложения, из которого было скопировано это приложение.
dataClassification	dataClassification	string	Метка классификации данных, назначенная приложению. Если классификация данных не включена, это не будет возвращено. Если классификация данных включена, но приложение не помечено, мы возвращаем значение None. Метки классификации данных можно добавить в консоль администрирования администратором области для планов Platform+.

createTableResponse

Имя	Путь	Тип	Описание
имя	name	string	Название таблицы.
id	id	string	Уникальный идентификатор (dbid) таблицы.
alias	alias	string	Автоматически созданный псевдоним таблицы для таблицы.
описание	description	string	Описание таблицы, настроенной администратором приложения.
создано	created	string	Время и дата создания таблицы в формате ВРЕМЕНИ ISO 8601 ггГГ-ММ-DDThh:mm:ss.sssZ (в часовом поясе UTC).
Обновлено	updated	string	Время и дата последнего обновления схемы таблицы или данных в формате ВРЕМЕНИ ISO 8601 ггГГ-ММ-DDThh:mm:ss.sssZ (в часовом поясе UTC).
nextRecordId	nextRecordId	integer	Добавочный идентификатор записи, который будет использоваться при создании следующей записи, как определено при выполнении вызова API.
nextFieldId	nextFieldId	integer	Добавочный идентификатор поля, который будет использоваться при создании следующего поля, как определено при выполнении вызова API.
defaultSortFieldId	defaultSortFieldId	integer	Идентификатор поля, настроенного для сортировки по умолчанию.
DefaultSortOrder	defaultSortOrder	DefaultSortOrder	Конфигурация порядка сортировки по умолчанию в таблице.
keyFieldId	keyFieldId	integer	Идентификатор поля, настроенного как ключ в этой таблице, который обычно является идентификатором записи quickbase.
singleRecordName	singleRecordName	string	Построитель настраивает единственное существительное таблицы.
pluralRecordName	pluralRecordName	string	Построитель, настроенный множественной существительной таблицы.
sizeLimit	sizeLimit	string	Ограничение размера таблицы.
spaceUsed	spaceUsed	string	Объем пространства, используемого в настоящее время таблицей.
spaceRemaining	spaceRemaining	string	Объем пространства, оставшегося для использования таблицей.

DefaultSortOrder

Конфигурация порядка сортировки по умолчанию в таблице.

Конфигурация порядка сортировки по умолчанию в таблице.

DefaultSortOrder

string

getTableResponse

Имя	Путь	Тип	Описание
имя	name	string	Название таблицы.
id	id	string	Уникальный идентификатор (dbid) таблицы.
alias	alias	string	Автоматически созданный псевдоним таблицы для таблицы.
описание	description	string	Описание таблицы, настроенной администратором приложения.
создано	created	string	Время и дата создания таблицы в формате ВРЕМЕНИ ISO 8601 ггГГ-ММ-DDThh:mm:ss.sssZ (в часовом поясе UTC).
Обновлено	updated	string	Время и дата последнего обновления схемы таблицы или данных в формате ВРЕМЕНИ ISO 8601 ггГГ-ММ-DDThh:mm:ss.sssZ (в часовом поясе UTC).
nextRecordId	nextRecordId	integer	Добавочный идентификатор записи, который будет использоваться при создании следующей записи, как определено при выполнении вызова API.
nextFieldId	nextFieldId	integer	Добавочный идентификатор поля, который будет использоваться при создании следующего поля, как определено при выполнении вызова API.
defaultSortFieldId	defaultSortFieldId	integer	Идентификатор поля, настроенного для сортировки по умолчанию.
DefaultSortOrder	defaultSortOrder	DefaultSortOrder	Конфигурация порядка сортировки по умолчанию в таблице.
keyFieldId	keyFieldId	integer	Идентификатор поля, настроенного как ключ в этой таблице, который обычно является идентификатором записи quickbase.
singleRecordName	singleRecordName	string	Построитель настраивает единственное существительное таблицы.
pluralRecordName	pluralRecordName	string	Построитель, настроенный множественной существительной таблицы.
sizeLimit	sizeLimit	string	Ограничение размера таблицы.
spaceUsed	spaceUsed	string	Объем пространства, используемого в настоящее время таблицей.
spaceRemaining	spaceRemaining	string	Объем пространства, оставшегося для использования таблицей.

updateTableResponse

Имя	Путь	Тип	Описание
имя	name	string	Название таблицы.
id	id	string	Уникальный идентификатор (dbid) таблицы.
alias	alias	string	Автоматически созданный псевдоним таблицы для таблицы.
описание	description	string	Описание таблицы, настроенной администратором приложения.
создано	created	string	Время и дата создания таблицы в формате ВРЕМЕНИ ISO 8601 ггГГ-ММ-DDThh:mm:ss.sssZ (в часовом поясе UTC).
Обновлено	updated	string	Время и дата последнего обновления схемы таблицы или данных в формате ВРЕМЕНИ ISO 8601 ггГГ-ММ-DDThh:mm:ss.sssZ (в часовом поясе UTC).
nextRecordId	nextRecordId	integer	Добавочный идентификатор записи, который будет использоваться при создании следующей записи, как определено при выполнении вызова API.
nextFieldId	nextFieldId	integer	Добавочный идентификатор поля, который будет использоваться при создании следующего поля, как определено при выполнении вызова API.
defaultSortFieldId	defaultSortFieldId	integer	Идентификатор поля, настроенного для сортировки по умолчанию.
DefaultSortOrder	defaultSortOrder	DefaultSortOrder	Конфигурация порядка сортировки по умолчанию в таблице.
keyFieldId	keyFieldId	integer	Идентификатор поля, настроенного как ключ в этой таблице, который обычно является идентификатором записи quickbase.
singleRecordName	singleRecordName	string	Построитель настраивает единственное существительное таблицы.
pluralRecordName	pluralRecordName	string	Построитель, настроенный множественной существительной таблицы.
sizeLimit	sizeLimit	string	Ограничение размера таблицы.
spaceUsed	spaceUsed	string	Объем пространства, используемого в настоящее время таблицей.
spaceRemaining	spaceRemaining	string	Объем пространства, оставшегося для использования таблицей.

deleteTableResponse

Имя	Путь	Тип	Описание
deletedTableId	deletedTableId	string	Идентификатор удаленной таблицы.

getRelationshipsResponse

Имя	Путь	Тип	Описание
Отношения	relationships	array of Relationship	Связи в таблице.
Метаданные	metadata	Metadata	Дополнительные сведения о результатах, которые могут быть полезны.

Relationship

Имя	Путь	Тип	Описание
id	id	integer	Идентификатор связи (идентификатор поля внешнего ключа).
parentTableId	parentTableId	string	Идентификатор родительской таблицы связи.
childTableId	childTableId	string	Идентификатор дочерней таблицы связи.
ForeignKeyField	foreignKeyField	ForeignKeyField	Сведения о поле внешнего ключа.
isCrossApp	isCrossApp	boolean	Является ли это связью между приложениями.
lookupFields	lookupFields	array of LookupField	Массив полей подстановки.
summaryFields	summaryFields	array of SummaryField	Массив полей сводки.

ForeignKeyField

Сведения о поле внешнего ключа.

Имя	Путь	Тип	Описание
id	id	integer	Идентификатор поля.
label	label	string	Метка поля.
type	type	string	Тип поля.

LookupField

Имя	Путь	Тип	Описание
id	id	integer	Идентификатор поля.
label	label	string	Метка поля.
type	type	string	Тип поля.

SummaryField

Имя	Путь	Тип	Описание
id	id	integer	Идентификатор поля.
label	label	string	Метка поля.
type	type	string	Тип поля.

Метаданные

Дополнительные сведения о результатах, которые могут быть полезны.

Имя	Путь	Тип	Описание
skip	skip	integer	Количество связей, которые нужно пропустить.
TotalRelationships	totalRelationships	integer	Общее количество связей.
numRelationships	numRelationships	integer	Количество связей в текущем объекте ответа.

createRelationshipResponse

Имя	Путь	Тип	Описание
id	id	integer	Идентификатор связи (идентификатор поля внешнего ключа).
parentTableId	parentTableId	string	Идентификатор родительской таблицы связи.
childTableId	childTableId	string	Идентификатор дочерней таблицы связи.
ForeignKeyField	foreignKeyField	ForeignKeyField	Сведения о поле внешнего ключа.
isCrossApp	isCrossApp	boolean	Является ли это связью между приложениями.
lookupFields	lookupFields	array of LookupField	Массив полей подстановки.
summaryFields	summaryFields	array of SummaryField	Массив полей сводки.

updateRelationshipResponse

Имя	Путь	Тип	Описание
id	id	integer	Идентификатор связи (идентификатор поля внешнего ключа).
parentTableId	parentTableId	string	Идентификатор родительской таблицы связи.
childTableId	childTableId	string	Идентификатор дочерней таблицы связи.
ForeignKeyField	foreignKeyField	ForeignKeyField	Сведения о поле внешнего ключа.
isCrossApp	isCrossApp	boolean	Является ли это связью между приложениями.
lookupFields	lookupFields	array of LookupField	Массив полей подстановки.
summaryFields	summaryFields	array of SummaryField	Массив полей сводки.

deleteRelationshipResponse

Имя	Путь	Тип	Описание
relationshipId	relationshipId	integer	Идентификатор связи.

Query

Определение запроса, настроенное в Quickbase, которое выполняется при запуске отчета.

Имя	Путь	Тип	Описание
tableId	tableId	string	Идентификатор таблицы для отчета.
фильтр	filter	string	Фильтр, используемый для запроса данных.
formulaFields	formulaFields	array of FormulaField	Вычисляемые поля формулы.

FormulaField

Имя	Путь	Тип	Описание
id	id	integer	Идентификатор поля формулы.
label	label	string	Метка поля формулы.
FieldType	fieldType	FieldType	Результирующий тип значения формулы.
формула	formula	string	Текст формулы.
decimalPrecision	decimalPrecision	integer	Для числовой формулы точность числа.

FieldType

Результирующий тип значения формулы.

Результирующий тип значения формулы.

FieldType

string

getReportResponse

Имя	Путь	Тип	Описание
id	id	string	Идентификатор отчета, уникальный для таблицы.
имя	name	string	Настроено имя отчета.
type	type	string	Тип отчета в Quickbase (например, диаграмма).
описание	description	string	Настроенное описание отчета.
ownerId	ownerId	integer	Необязательно, отображается только для личных отчетов. Идентификатор пользователя владельца отчета.
Query	query	Query	Определение запроса, настроенное в Quickbase, которое выполняется при запуске отчета.
properties	properties	object	Список свойств, относящихся к типу отчета. Подробные описания свойств для каждого типа отчета см. в разделе "Типы отчетов".
usedLast	usedLast	string	Момент последнего использования отчета.
usedCount	usedCount	integer	Количество использованных отчетов.

runReportResponse

Имя	Путь	Тип	Описание
столбцов	fields	array of Field	Массив объектов, содержащих ограниченные метаданные каждого поля, отображаемого в отчете. Это помогает создавать логику, которая зависит от типов полей и идентификаторов.
данные	data	array of object	Массив объектов, представляющих данные записи или суммированные значения, в зависимости от типа отчета.
items	data	object
Метаданные1	metadata	Metadata1	Дополнительные сведения о результатах, которые могут быть полезны. Может потребоваться разбиение на страницы, если указать меньшее количество результатов для пропуска, чем доступно, или если API автоматически возвращает меньше результатов. numRecords можно сравнить с totalRecords, чтобы определить, требуется ли дальнейшее разбиение на страницы.

Поле

Имя	Путь	Тип	Описание
id	id	integer	Идентификатор поля.
label	label	string	Метка поля.
type	type	string	Тип поля.
labelOverride	labelOverride	string	Переопределение метки заголовка столбца для поля в отчете.

Метаданные1

Дополнительные сведения о результатах, которые могут быть полезны. Может потребоваться разбиение на страницы, если указать меньшее количество результатов для пропуска, чем доступно, или если API автоматически возвращает меньше результатов. numRecords можно сравнить с totalRecords, чтобы определить, требуется ли дальнейшее разбиение на страницы.

Имя	Путь	Тип	Описание
skip	skip	integer	Количество записей, которые нужно пропустить
numFields	numFields	integer	Количество полей в каждой записи в текущем объекте ответа
top	top	integer	При наличии максимальное число записей, запрошенных вызывающим абонентом
totalRecords	totalRecords	integer	Общее количество записей в результирующем наборе
numRecords	numRecords	integer	Количество записей в текущем объекте ответа

Свойства1

Дополнительные свойства для поля. Дополнительные сведения о свойствах каждого типа поля см. на странице сведений о типе поля.

Имя	Путь	Тип	Описание
comments	comments	string	Примечания, введенные в свойства поля администратором.
doesTotal	doesTotal	boolean	Будет ли это поле итогом в отчетах в продукте.
автосохранение	autoSave	boolean	Будет ли поле ссылки автоматически сохраняться.
defaultValueLuid	defaultValueLuid	integer	Значение идентификатора пользователя по умолчанию.
maxVersions	maxVersions	integer	Максимальное количество версий, настроенных для вложения файла.
carryChoices	carryChoices	boolean	Следует ли копировать поле с несколькими полями выбора.
format	format	integer	Формат для отображения времени.
максимальная длина	maxLength	integer	Максимальное количество символов, разрешенных для записи в Quickbase для этого поля.
linkText	linkText	string	Настроенное текстовое значение, которое заменяет URL-адрес, который пользователи видят в продукте.
parentFieldId	parentFieldId	integer	Идентификатор родительского составного поля, если применимо.
displayTimezone	displayTimezone	boolean	Указывает, следует ли отображать часовой пояс в продукте.
summaryTargetFieldId	summaryTargetFieldId	integer	Идентификатор поля, используемого для агрегирования значений из дочернего элемента, если применимо. Отображается значение 0, если сводная функция не требует выбора поля (например, счетчика).
allowNewChoices	allowNewChoices	boolean	Указывает, могут ли пользователи добавлять новые варианты в список выбора.
masterChoiceFieldId	masterChoiceFieldId	integer	Идентификатор поля, которое является ссылкой в связи.
defaultToday	defaultToday	boolean	Указывает, используется ли значение поля по умолчанию для новых записей.
Единиц	units	string	Метка единиц.
lookupTargetFieldId	lookupTargetFieldId	integer	Идентификатор поля, которое является целевым объектом в главной таблице для этого подстановки.
СводкаFunction	summaryFunction	SummaryFunction	Тип функции сводного накопления.
sourceFieldId	sourceFieldId	integer	Идентификатор исходного поля.
masterTableTag	masterTableTag	string	Псевдоним таблицы для главной таблицы в связи с этим полем является частью.
doesAverage	doesAverage	boolean	Значение этого поля в отчетах в продукте.
формула	formula	string	Формула поля, настроенная в Quickbase.
decimalPlaces	decimalPlaces	integer	Число десятичных разрядов, отображаемых в продукте для этого поля.
seeVersions	seeVersions	boolean	Указывает, может ли пользователь видеть другие версии, помимо последних, вложений в файл в продукте.
displayMonth	displayMonth	string	Отображение месяцев.
numLines	numLines	integer	Количество строк, отображаемых в Quickbase для этого текстового поля.
displayEmail	displayEmail	string	Отображение сообщения электронной почты.
defaultKind	defaultKind	string	Тип пользователя по умолчанию.
coverText	coverText	string	Альтернативный понятный текст, который можно использовать для отображения ссылки в браузере.
currencySymbol	currencySymbol	string	Текущий символ, используемый при отображении значений полей в продукте.
masterChoiceTableId	masterChoiceTableId	integer	Идентификатор таблицы, которая является главной в этой связи.
targetFieldId	targetFieldId	integer	Идентификатор целевого поля.
displayUser	displayUser	string	Настроенный параметр для отображения пользователей в продукте.
blankIsZero	blankIsZero	boolean	Считается ли пустое значение таким же, как 0 в вычислениях в продукте.
точный	exact	boolean	Требуется ли точное совпадение для ссылки отчета.
startField	startField	integer	Идентификатор начального поля.
DefaultDomain	defaultDomain	string	Домен электронной почты по умолчанию.
defaultValue	defaultValue	string	Значение по умолчанию, настроенное для поля при добавлении новой записи.
choicesLuid	choicesLuid	array of object	Список вариантов пользователей.
items	choicesLuid	object
сокращать	abbreviate	boolean	Не отображайте протокол URL-адреса при отображении URL-адреса.
xmlTag	xmlTag	string	Xml-тег поля.
targetTableName	targetTableName	string	Имя целевой таблицы поля.
форматЧисла	numberFormat	integer	Формат, используемый для отображения числовых значений в продукте (десятичные, разделители, группа цифр).
отображается	appearsAs	string	Текст ссылки, если пустой, URL-адрес будет использоваться в качестве текста ссылки.
Ширина	width	integer	Ширина входных данных поля в продукте.
CurrencyFormat	currencyFormat	CurrencyFormat	Формат валюты, используемый при отображении значений полей в продукте.
displayImages	displayImages	boolean	Указывает, будут ли изображения отображаться для вложений файлов в формах и отчетах в продукте.
foreignKey	foreignKey	boolean	Указывает, является ли поле внешним ключом (или полем ссылки) в связи.
displayDayOfWeek	displayDayOfWeek	boolean	Указывает, следует ли отображать день недели в продукте.
summaryReferenceFieldId	summaryReferenceFieldId	integer	Идентификатор поля, которое является ссылкой в связи для этой сводки.
запятаяStart	commaStart	integer	Количество цифр перед отображением запятых в продукте при необходимости.
choices	choices	array of string	Массив записей, которые существуют для поля, которое предлагает пользователю выбор.
targetTableId	targetTableId	string	Идентификатор целевой таблицы.
displayRelative	displayRelative	boolean	Указывает, следует ли отображать время как относительное.
составные поля	compositeFields	array of object	Массив полей, составляющих составное поле (например, адрес).
items	compositeFields	object
VersionMode	versionMode	VersionMode	Режимы версий для файлов. Сохраните все версии и сохраните последнюю версию.
displayTime	displayTime	boolean	Указывает, следует ли отображать время в дополнение к дате.
durationField	durationField	integer	Идентификатор поля длительности.
snapFieldId	snapFieldId	integer	Идентификатор поля, используемого для значений моментального снимка при необходимости.
часы24	hours24	boolean	Указывает, следует ли отображать время в формате 24 часа в продукте.
sortAlpha	sortAlpha	boolean	Следует ли отсортировать по алфавиту, сортировка по умолчанию — по идентификатору записи.
sortAsGiven	sortAsGiven	boolean	Указывает, сортируются ли перечисленные записи в алфавитном порядке.
hasExtension	hasExtension	boolean	Имеет ли это поле расширение телефона.
рабочая неделя	workWeek	integer	Тип рабочей недели.
useNewWindow	useNewWindow	boolean	Указывает, должен ли URL-адрес открыть новое окно, когда пользователь щелкает его в продукте.
appendOnly	appendOnly	boolean	Указывает, является ли это поле только добавлением.
displayAsLink	displayAsLink	boolean	Указывает, должно ли поле, являющееся частью связи, отображаться как гиперссылка на родительскую запись в продукте.
allowHTML	allowHTML	boolean	Разрешает ли это поле html.
lookupReferenceFieldId	lookupReferenceFieldId	integer	Идентификатор поля, которое является ссылкой в связи для этого поиска.

СводкаFunction

Тип функции сводного накопления.

Тип функции сводного накопления.

СводкаFunction

string

CurrencyFormat

Формат валюты, используемый при отображении значений полей в продукте.

Формат валюты, используемый при отображении значений полей в продукте.

CurrencyFormat

string

VersionMode

Режимы версий для файлов. Сохраните все версии и сохраните последнюю версию.

Режимы версий для файлов. Сохраните все версии и сохраните последнюю версию.

VersionMode

string

Разрешение

Имя	Путь	Тип	Описание
роль	role	string	Роль, связанная с заданным разрешением для поля
permissionType	permissionType	string	Разрешение, предоставленное роли для этого поля
roleId	roleId	integer	Идентификатор заданной роли

createFieldResponse

Имя	Путь	Тип	Описание
id	id	integer	Идентификатор поля, уникального для этой таблицы.
fieldType	fieldType	string	Тип поля, как описано здесь.
mode	mode	string	Для производных полей это будет "подстановка", "сводка" или "формула", чтобы указать тип производного поля. Для непроизводных полей это будет пустым.
label	label	string	Метка (имя) поля.
noWrap	noWrap	boolean	Указывает, настроено ли поле не упаковывать при отображении в продукте.
bold	bold	boolean	Указывает, настроено ли поле для отображения полужирным шрифтом в продукте.
required	required	boolean	Указывает, является ли поле обязательным.
отображаетсяByDefault	appearsByDefault	boolean	Указывает, помечено ли поле как значение по умолчанию в отчетах.
findEnabled	findEnabled	boolean	Указывает, помечено ли поле как доступное для поиска.
уникальный	unique	boolean	Указывает, отмечено ли поле уникальным.
doesDataCopy	doesDataCopy	boolean	Указывает, копируются ли данные поля при копировании записи пользователем.
fieldHelp	fieldHelp	string	Настроенный текст справки, отображаемый пользователям в продукте.
Аудит	audited	boolean	Указывает, отслеживается ли поле в рамках журналов аудита quickbase.
Свойства1	properties	Properties1	Дополнительные свойства для поля. Дополнительные сведения о свойствах каждого типа поля см. на странице сведений о типе поля.
permissions	permissions	array of Permission	Разрешения поля для разных ролей.

deleteFieldsResponse

Имя	Путь	Тип	Описание
deletedFieldIds	deletedFieldIds	array of integer	Список идентификаторов полей, которые нужно удалить.
Ошибки	errors	array of string	Список обнаруженных ошибок.

getFieldResponse

Имя	Путь	Тип	Описание
id	id	integer	Идентификатор поля, уникального для этой таблицы.
fieldType	fieldType	string	Тип поля, как описано здесь.
mode	mode	string	Для производных полей это будет "подстановка", "сводка" или "формула", чтобы указать тип производного поля. Для непроизводных полей это будет пустым.
label	label	string	Метка (имя) поля.
noWrap	noWrap	boolean	Указывает, настроено ли поле не упаковывать при отображении в продукте.
bold	bold	boolean	Указывает, настроено ли поле для отображения полужирным шрифтом в продукте.
required	required	boolean	Указывает, является ли поле обязательным.
отображаетсяByDefault	appearsByDefault	boolean	Указывает, помечено ли поле как значение по умолчанию в отчетах.
findEnabled	findEnabled	boolean	Указывает, помечено ли поле как доступное для поиска.
уникальный	unique	boolean	Указывает, отмечено ли поле уникальным.
doesDataCopy	doesDataCopy	boolean	Указывает, копируются ли данные поля при копировании записи пользователем.
fieldHelp	fieldHelp	string	Настроенный текст справки, отображаемый пользователям в продукте.
Аудит	audited	boolean	Указывает, отслеживается ли поле в рамках журналов аудита quickbase.
Свойства1	properties	Properties1	Дополнительные свойства для поля. Дополнительные сведения о свойствах каждого типа поля см. на странице сведений о типе поля.
permissions	permissions	array of Permission	Разрешения поля для разных ролей.

updateFieldResponse

Имя	Путь	Тип	Описание
id	id	integer	Идентификатор поля, уникального для этой таблицы.
fieldType	fieldType	string	Тип поля, как описано здесь.
mode	mode	string	Для производных полей это будет "подстановка", "сводка" или "формула", чтобы указать тип производного поля. Для непроизводных полей это будет пустым.
label	label	string	Метка (имя) поля.
noWrap	noWrap	boolean	Указывает, настроено ли поле не упаковывать при отображении в продукте.
bold	bold	boolean	Указывает, настроено ли поле для отображения полужирным шрифтом в продукте.
required	required	boolean	Указывает, является ли поле обязательным.
отображаетсяByDefault	appearsByDefault	boolean	Указывает, помечено ли поле как значение по умолчанию в отчетах.
findEnabled	findEnabled	boolean	Указывает, помечено ли поле как доступное для поиска.
уникальный	unique	boolean	Указывает, отмечено ли поле уникальным.
doesDataCopy	doesDataCopy	boolean	Указывает, копируются ли данные поля при копировании записи пользователем.
fieldHelp	fieldHelp	string	Настроенный текст справки, отображаемый пользователям в продукте.
Аудит	audited	boolean	Указывает, отслеживается ли поле в рамках журналов аудита quickbase.
Свойства1	properties	Properties1	Дополнительные свойства для поля. Дополнительные сведения о свойствах каждого типа поля см. на странице сведений о типе поля.
permissions	permissions	array of Permission	Разрешения поля для разных ролей.

runFormulaResponse

Имя	Путь	Тип	Описание
результат	result	string	Результат выполнения формулы.

upsertResponse

Успешный ответ, содержащий сведения о записях, добавленных, обновленных или без изменений. В приведенном ниже примере таблица ранее имела десять записей с идентификаторами от 1 до 10. Пользователь публикует upsert, который обновляет значение записи 1 и добавляет две новые записи, все успешно.

Имя	Путь	Тип	Описание
Метаданные2	metadata	Metadata2	Сведения о созданных записях, обновленных записях, на которые ссылаются, но без изменений, а также о записях с ошибками при обработке.
данные	data	array of object	Возвращаемые данные.
items	data	object

Метаданные2

Сведения о созданных записях, обновленных записях, на которые ссылаются, но без изменений, а также о записях с ошибками при обработке.

Имя	Путь	Тип	Описание
createdRecordIds	createdRecordIds	array of integer	Массив, содержащий идентификаторы созданной записи.
lineErrors	lineErrors	object	Это будет возвращено только в случае неудачных записей. Это коллекция ошибок, возникших при обработке входящих данных, которые привели к тому, что записи не обрабатываются. Каждый объект имеет ключ, представляющий порядковый номер записи в исходной полезных данных (начиная с 1). Значением является список ошибок.
без измененийRecordIds	unchangedRecordIds	array of integer	Массив, содержащий без изменений идентификаторы записей.
обновленоRecordIds	updatedRecordIds	array of integer	Массив, содержащий обновленные идентификаторы записей.
totalNumberOfRecordsProcessed	totalNumberOfRecordsProcessed	integer	Количество обработанных записей. Включает успешные и неудачные обновления записей.

deleteRecordsResponse

Имя	Путь	Тип	Описание
numberDeleted	numberDeleted	integer	Число удаленных записей.

runQueryResponse

Имя	Путь	Тип	Описание
столбцов	fields	array of Fields2	Массив объектов, содержащих ограниченные метаданные каждого поля, отображаемого в отчете. Это помогает создавать логику, которая зависит от типов полей и идентификаторов.
данные	data	array of object	Массив объектов, представляющих данные записи или суммированные значения, в зависимости от типа отчета.
items	data	object
Метаданные1	metadata	Metadata1	Дополнительные сведения о результатах, которые могут быть полезны. Может потребоваться разбиение на страницы, если указать меньшее количество результатов для пропуска, чем доступно, или если API автоматически возвращает меньше результатов. numRecords можно сравнить с totalRecords, чтобы определить, требуется ли дальнейшее разбиение на страницы.

Поля2

Имя	Путь	Тип	Описание
id	id	integer	Идентификатор поля.
label	label	string	Метка поля.
type	type	string	Тип поля.

getTempTokenDBIDResponse

Имя	Путь	Тип	Описание
временнаяauthorization	temporaryAuthorization	string	Временный маркер авторизации.

cloneUserTokenResponse

Имя	Путь	Тип	Описание
активный	active	boolean	Активен ли маркер пользователя.
apps	apps	array of App	Список приложений, которым назначен этот маркер пользователя.
LastUsed	lastUsed	string	Последняя дата использования этого маркера пользователя в формате ВРЕМЕНИ ISO 8601 ггГГ-ММ-DDThh:mm:ss.sssZ (в часовом поясе UTC).
описание	description	string	Описание маркера пользователя.
id	id	integer	Идентификатор маркера пользователя.
имя	name	string	Имя маркера пользователя.
token	token	string	Значение маркера пользователя.

Приложение

Имя	Путь	Тип	Описание
id	id	string	Уникальный идентификатор для этого приложения.
имя	name	string	Имя приложения.

deleteUserTokenResponse

Имя	Путь	Тип	Описание
id	id	integer	Идентификатор маркера пользователя.

deleteFileResponse

Имя	Путь	Тип	Описание
versionNumber	versionNumber	integer	Число удаленных версий.
fileName	fileName	string	Имя файла, связанного с удаленной версией.
Загружены	uploaded	string	Метка времени при первоначальной отправке версии.
Создатель	creator	Creator	Пользователь, отправив версию.

Создатель

Пользователь, отправив версию.

Имя	Путь	Тип	Описание
имя	name	string	Полное имя пользователя.
id	id	string	Идентификатор пользователя.
электронная почта	email	string	Электронная почта пользователя.
userName	userName	string	Имя пользователя, обновленное в свойствах пользователя. Необязательный параметр отображается, если не совпадает с адресом электронной почты пользователя.

струна

Это базовый тип данных string.