Quickbase (Éditeur indépendant)

Quickbase est une plateforme de développement d’applications qui unit les équipes métier et informatiques en permettant aux résolveurs de problèmes de n’importe quel arrière-plan technique de travailler ensemble pour créer de manière sécurisée, sécurisée et durable un écosystème d’applications. Quickbase aide les entreprises à accélérer l’innovation continue des processus uniques en permettant le développement citoyen à grande échelle sur une plateforme commune.

Ce connecteur est disponible dans les produits et régions suivants :

Service	classe	Régions
Copilot Studio	Premium	Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD)
Applications logiques	Norme	Toutes les régions Logic Apps , à l’exception des suivantes : - Régions Azure Government - Régions Azure Chine - Us Department of Defense (DoD)
Power Apps	Premium	Toutes les régions Power Apps , à l’exception des suivantes : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD)
Power Automate	Premium	Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD)

Contact
Nom	Troy Taylor
URL	https://www.hitachisolutions.com
Messagerie électronique	ttaylor@hitachisolutions.com

Métadonnées du connecteur
Éditeur	Troy Taylor, Hitachi Solutions
Site web	https://www.quickbase.com/
Politique de confidentialité	https://www.quickbase.com/privacy
Catégories	Productivité ;Opérations informatiques

Création d’une connexion

Le connecteur prend en charge les types d’authentification suivants :


Par défaut	Paramètres de création de connexion.	Toutes les régions	Impossible à partager

Faire défaut

Applicable : Toutes les régions

Paramètres de création de connexion.

Ce n’est pas une connexion partageable. Si l’application Power est partagée avec un autre utilisateur, un autre utilisateur sera invité à créer explicitement une nouvelle connexion.

Nom	Type	Descriptif	Obligatoire
Nom d’hôte du domaine	ficelle	Spécifiez le nom d’hôte de votre domaine.	Vrai
Authorization	securestring	Jeton utilisateur de la forme « QB-USER-TOKEN yourToken ».	Vrai

Limitations

Nom	Appels	Période de renouvellement
Appels d’API par connexion	100	60 secondes

Actions

Cloner un jeton utilisateur	Clone le jeton utilisateur authentifié. Toutes les applications associées à ce jeton sont automatiquement associées au nouveau jeton.
Copier une application	Copie l’application spécifiée. La nouvelle application aura le même schéma que l’original. Consultez ci-dessous pour obtenir des options de copie supplémentaires.
Créer un champ	Crée un champ dans une table, y compris les autorisations personnalisées de ce champ.
Créer une application	Crée une application dans un compte. Vous devez disposer de droits de création d’application dans le compte respectif. Les propriétés principales et les variables d’application peuvent être définies avec cette API.
Créer une relation	Crée une relation dans une table ainsi que des champs de recherche/résumé. Les relations ne peuvent être créées que pour les tables au sein de la même application.
Créer une table	Crée une table dans une application.
Désactiver un jeton utilisateur	Désactive le jeton utilisateur authentifié. Une fois cette opération terminée, le jeton utilisateur doit être réactivé dans l’interface utilisateur.
Exécuter un rapport	Exécute un rapport, en fonction d’un ID et retourne les données sous-jacentes associées. Le format des données varie en fonction du type de rapport. Les rapports qui se concentrent sur les données au niveau de l’enregistrement (table, calendrier, etc.) retournent les enregistrements individuels. Les rapports agrégés (résumé, graphique) retournent les informations résumées comme configurés dans le rapport. Les éléments spécifiques à l’interface utilisateur ne sont pas retournés, tels que les totaux, les moyennes et les visualisations. Retourne des données avec pagination intelligente en fonction de la taille approximative de chaque enregistrement. L’objet de métadonnées inclut les informations nécessaires pour itérer sur la réponse et collecter plus de données.
Exécuter une formule	Autorise l’exécution d’une formule via un appel d’API. Utilisez cette méthode dans le code personnalisé pour récupérer la valeur d’une formule sans champ discret sur un enregistrement.
Insérer des enregistrements de mise à jour andor	Insérez et/ou mettez à jour des enregistrements dans une table. Dans cet appel d’API unique, les insertions et les mises à jour peuvent être envoyées. La mise à jour peut utiliser le champ clé sur la table ou tout autre champ unique pris en charge. Pour plus d’informations sur la façon dont chaque type de champ doit être mis en forme, reportez-vous à la page Types de champs. Cette opération permet un traitement incrémentiel des enregistrements réussis, même en cas d’échec de certains enregistrements. Note: Ce point de terminaison prend en charge une taille maximale de charge utile de 10 Mo.
Mettre à jour un champ	Met à jour les propriétés et les autorisations personnalisées d’un champ. La tentative de mise à jour de certaines propriétés peut entraîner la non-respect des nouvelles propriétés du champ et peut être rejetée. Consultez les descriptions des éléments requis, uniques et choix, ci-dessous, pour connaître des situations spécifiques. Toutes les propriétés du champ que vous ne spécifiez pas dans le corps de la demande restent inchangées.
Mettre à jour une application	Met à jour les principales propriétés et/ou variables d’application pour une application spécifique. Toutes les propriétés de l’application que vous ne spécifiez pas dans le corps de la requête restent inchangées.
Mettre à jour une relation	Utilisez ce point de terminaison pour ajouter des champs de recherche et des champs récapitulatives à une relation existante. La mise à jour d’une relation ne supprime pas les champs de recherche/résumé existants.
Mettre à jour une table	Met à jour les propriétés principales d’une table spécifique. Toutes les propriétés de la table que vous ne spécifiez pas dans le corps de la requête restent inchangées.
Obtenir des champs pour une table	Obtient les propriétés de tous les champs d’une table spécifique. Les propriétés de chaque champ sont identiques à celles du champ Get.
Obtenir des tables pour une application	Obtient une liste de toutes les tables qui existent dans une application spécifique. Les propriétés de chaque table sont identiques à celles retournées dans La table Get.
Obtenir des événements d’application	Obtenez la liste des événements qui peuvent être déclenchés en fonction des données ou des actions utilisateur de cette application, notamment : notification par e-mail, rappels, abonnements, actions QB, webhooks, enregistrement des automatisations déclenchées par modification (n’inclut pas d’automatisation planifiée).
Obtenir le champ	Obtient les propriétés d’un champ individuel, en fonction de l’ID de champ. Les propriétés présentes sur tous les types de champs sont retournées au niveau supérieur. Les propriétés propres à un type de champ spécifique sont retournées sous l’attribut « properties ». Pour plus d’informations sur les propriétés de chaque type de champ, consultez la page Types de champs.
Obtenir l’utilisation de tous les champs	Obtenez toutes les statistiques d’utilisation des champs pour une table. Il s’agit d’un résumé des informations disponibles dans la table d’utilisation des propriétés de champ.
Obtenir tous les rapports de table	Obtenez le schéma (propriétés) de tous les rapports d’une table. Si l’utilisateur exécutant l’API est administrateur d’application, l’API retourne également tous les rapports personnels avec l’ID d’utilisateur du propriétaire.
Obtenir toutes les relations	Obtenez une liste de toutes les relations et de leurs définitions pour une table spécifique. Les détails sont fournis à la fois pour les côtés parent et enfant des relations au sein d’une application donnée. Des détails limités sont retournés pour les relations entre applications.
Obtenir un jeton temporaire pour un DBID	Utilisez ce point de terminaison pour obtenir un jeton d’autorisation temporaire, limité à une application ou à une table. Vous pouvez ensuite utiliser ce jeton pour effectuer d’autres appels d’API (voir autorisation). Ce jeton expire dans 5 minutes.
Obtenir un rapport	Obtenez le schéma (propriétés) d’un rapport individuel.
Obtenir une application	Retourne les propriétés principales d’une application, y compris les variables d’application.
Obtenir une table	Obtient les propriétés d’une table individuelle qui fait partie d’une application.
Obtenir une utilisation de champ	Obtenez des statistiques d’utilisation de champs uniques. Il s’agit d’un résumé des informations disponibles dans la table d’utilisation des propriétés de champ.
Rechercher des données	Transmettez une requête dans le langage de requête Quickbase. Retourne des données d’enregistrement avec pagination intelligente en fonction de la taille approximative de chaque enregistrement. L’objet de métadonnées inclut les informations nécessaires pour itérer sur la réponse et collecter plus de données.
Suppression d’une table	Supprime une table spécifique dans une application, y compris toutes les données qu’elle contient.
Supprimer des champs	Supprime un ou plusieurs champs d’une table, en fonction de l’ID de champ. Cela supprime également définitivement toutes les données ou calculs de ce champ.
Supprimer des enregistrements	Supprime les enregistrements d’une table en fonction d’une requête. Vous pouvez également supprimer tous les enregistrements de la table.
Supprimer un jeton utilisateur	Supprime le jeton d’utilisateur authentifié. Ce n’est pas réversible.
Supprimer une application	Supprime une application entière, y compris toutes les tables et données.
Supprimer une pièce jointe	Supprime une version de pièce jointe de fichier. Les métadonnées sur les fichiers peuvent être récupérées à partir des points de terminaison /records et /reports, le cas échéant. Utilisez ces points de terminaison pour obtenir les informations nécessaires pour supprimer les versions de fichiers.
Supprimer une relation	Utilisez ce point de terminaison pour supprimer une relation entière, y compris tous les champs de recherche et de résumé. Le champ de référence de la relation ne sera pas supprimé.
Télécharger une pièce jointe	Télécharge la pièce jointe du fichier, avec le contenu de pièce jointe encodé au format base64. La réponse de l’API retourne le nom du fichier dans l’en-tête `Content-Disposition` . Les métadonnées sur les fichiers peuvent être récupérées à partir des points de terminaison /records et /reports, le cas échéant. Utilisez ces points de terminaison pour obtenir les informations nécessaires pour extraire des fichiers.

Cloner un jeton utilisateur

ID d’opération :: CloneUserToken

Clone le jeton utilisateur authentifié. Toutes les applications associées à ce jeton sont automatiquement associées au nouveau jeton.

Paramètres

Nom	Clé	Obligatoire	Type	Description
nom	name		string	Nouveau nom du jeton d’utilisateur cloné.
descriptif	description		string	Description du jeton d’utilisateur cloné.

Retours

Cloner la réponse du jeton utilisateur: cloneUserTokenResponse

Copier une application

ID d’opération :: CopyApp

Copie l’application spécifiée. La nouvelle application aura le même schéma que l’original. Consultez ci-dessous pour obtenir des options de copie supplémentaires.

Paramètres

Nom	Clé	Obligatoire	Type	Description
nom	name	True	string	Nom de l’application nouvellement copiée
descriptif	description		string	Description de l’application nouvellement copiée
assignUserToken	assignUserToken		boolean	Indique s’il faut ajouter le jeton utilisateur utilisé pour effectuer cette demande à la nouvelle application
excludeFiles	excludeFiles		boolean	Si keepData a la valeur true, indique s’il faut également copier les pièces jointes du fichier. Si keepData a la valeur false, cette propriété est ignorée
keepData	keepData		boolean	Indique s’il faut copier les données de l’application avec le schéma
usersAndRoles	usersAndRoles		boolean	Si la valeur est true, les utilisateurs sont copiés avec leurs rôles attribués. Si la valeur est false, les utilisateurs et les rôles sont copiés, mais les rôles ne sont pas affectés
ID d’application	appId	True	string	Identificateur unique d’une application.

Retours

Copier la réponse de l’application: copyAppResponse

Créer un champ

ID d’opération :: CreateField

Crée un champ dans une table, y compris les autorisations personnalisées de ce champ.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Table ID	tableId	True	string	Identificateur unique de la table.
Vérifiés	audited		boolean	Indique si le champ est suivi dans le cadre des journaux d’audit De base rapide. Vous ne pouvez définir cette propriété que sur « true » si l’application a activé les journaux d’audit. Consultez Activer les journaux de modification des données sous Journaux d’audit De base rapide.
fieldHelp	fieldHelp		string	Texte d’aide configuré affiché aux utilisateurs du produit.
audacieux	bold		boolean	Indique si le champ est configuré pour s’afficher en gras dans le produit.
comments	comments		string	Commentaires entrés sur les propriétés de champ par un administrateur.
doesTotal	doesTotal		boolean	Indique si ce champ est total dans les rapports au sein du produit.
enregistrement automatique	autoSave		boolean	Indique si le champ de lien est automatiquement enregistré.
defaultValueLuid	defaultValueLuid		integer	Valeur d’ID d’utilisateur par défaut.
maxVersions	maxVersions		integer	Nombre maximal de versions configurées pour une pièce jointe de fichier.
format	format		integer	Format à afficher l’heure.
carryChoices	carryChoices		boolean	Indique si le champ doit contenir ses champs de choix multiples lors de la copie.
longueur maximale	maxLength		integer	Nombre maximal de caractères autorisés pour l’entrée dans Quickbase pour ce champ.
linkText	linkText		string	Valeur de texte configurée qui remplace l’URL que les utilisateurs voient dans le produit.
parentFieldId	parentFieldId		integer	ID du champ composite parent, le cas échéant.
displayTimezone	displayTimezone		boolean	Indique s’il faut afficher le fuseau horaire dans le produit.
allowNewChoices	allowNewChoices		boolean	Indique si les utilisateurs peuvent ajouter de nouveaux choix à une liste de sélection.
defaultToday	defaultToday		boolean	Indique si la valeur du champ est définie par défaut aujourd’hui pour les nouveaux enregistrements.
Unités	units		string	Étiquette d’unités.
sourceFieldId	sourceFieldId		integer	ID du champ source.
doesAverage	doesAverage		boolean	Indique si ce champ est moyen dans les rapports au sein du produit.
formule	formula		string	Formule du champ tel qu’il est configuré dans Quickbase.
Décimales	decimalPlaces		integer	Nombre de décimales affichées dans le produit pour ce champ.
displayMonth	displayMonth		string	Comment afficher des mois.
seeVersions	seeVersions		boolean	Indique si l’utilisateur peut voir d’autres versions, à l’exception de la plus récente, d’une pièce jointe de fichier dans le produit.
numLines	numLines		integer	Nombre de lignes affichées dans Quickbase pour ce champ de texte.
defaultKind	defaultKind		string	Type par défaut de l’utilisateur.
displayEmail	displayEmail		string	Affichage de l’e-mail.
coverText	coverText		string	Texte convivial de remplacement qui peut être utilisé pour afficher un lien dans le navigateur.
currencySymbol	currencySymbol		string	Symbole actuel utilisé lors de l’affichage des valeurs de champ dans le produit.
targetFieldId	targetFieldId		integer	ID du champ cible.
displayUser	displayUser		string	Option configurée pour la façon dont les utilisateurs s’affichent dans le produit.
blankIsZero	blankIsZero		boolean	Indique si une valeur vide est traitée comme 0 dans les calculs au sein du produit.
exact	exact		boolean	Indique si une correspondance exacte est requise pour un lien de rapport.
defaultDomain	defaultDomain		string	Domaine de messagerie par défaut.
defaultValue	defaultValue		string	Valeur par défaut configurée pour un champ lorsqu’un nouvel enregistrement est ajouté.
abréger	abbreviate		boolean	N’affichez pas le protocole d’URL lors de l’affichage de l’URL.
formatNombre	numberFormat		integer	Format utilisé pour afficher des valeurs numériques dans le produit (décimal, séparateurs, groupe de chiffres).
targetTableName	targetTableName		string	Nom de la table cible du champ.
appearsAs	appearsAs		string	Le texte du lien, s’il est vide, l’URL sera utilisée comme texte de lien.
width	width		integer	Largeur d’entrée html du champ dans le produit.
CurrencyFormat	currencyFormat		string	Format monétaire utilisé lors de l’affichage des valeurs de champ dans le produit.
displayImages	displayImages		boolean	Indique si les images s’affichent pour les pièces jointes de fichiers sur les formulaires et les rapports au sein du produit.
displayDayOfWeek	displayDayOfWeek		boolean	Indique s’il faut afficher le jour de la semaine dans le produit.
virguleStart	commaStart		integer	Nombre de chiffres avant l’affichage des virgules dans le produit, le cas échéant.
choices	choices		array of string	Tableau d’entrées qui existent pour un champ qui offre des choix à l’utilisateur. Notez que ces choix font référence aux valeurs valides des enregistrements ajoutés à l’avenir. Vous êtes autorisé à supprimer des valeurs de la liste des choix, même s’il existe des enregistrements existants avec ces valeurs dans ce champ. Ils seront affichés en rouge lorsque les utilisateurs examinent les données dans le navigateur, mais il n’y a aucun autre effet. Lors de la mise à jour d’un champ avec cette propriété, les anciens choix sont supprimés et remplacés par les nouveaux choix.
targetTableId	targetTableId		string	ID de la table cible.
displayRelative	displayRelative		boolean	Indique s’il faut afficher l’heure en tant que relative.
compositeFields	compositeFields		object
displayTime	displayTime		boolean	Indique s’il faut afficher l’heure, en plus de la date.
VersionMode	versionMode		string	Modes de version pour les fichiers. Conservez toutes les versions et conservez la dernière version.
snapFieldId	snapFieldId		integer	ID du champ utilisé pour les valeurs d’instantané, le cas échéant.
heures24	hours24		boolean	Indique s’il faut afficher l’heure dans le format de 24 heures dans le produit.
sortAlpha	sortAlpha		boolean	Indique s’il faut trier par ordre alphabétique, le tri par défaut est par ID d’enregistrement.
sortAsGiven	sortAsGiven		boolean	Indique si les entrées répertoriées trient comme entrées par ordre alphabétique.
hasExtension	hasExtension		boolean	Indique si ce champ a une extension de téléphone.
useNewWindow	useNewWindow		boolean	Indique si l’URL doit ouvrir une nouvelle fenêtre lorsqu’un utilisateur clique dessus dans le produit.
appendOnly	appendOnly		boolean	Indique si ce champ est ajouté uniquement.
displayAsLink	displayAsLink		boolean	Indique si un champ qui fait partie de la relation doit être affiché en tant que lien hypertexte vers l’enregistrement parent dans le produit.
appearsByDefault	appearsByDefault		boolean	Indique si le champ est marqué comme valeur par défaut dans les rapports.
FieldType2	fieldType	True	string	Les types de champs, cliquez sur l’un des liens de type de champ pour plus d’informations.
role	role		string	Rôle associé à une autorisation donnée pour le champ
permissionType	permissionType		string	Autorisation donnée au rôle pour ce champ
roleId	roleId		integer	ID du rôle donné
addToForms	addToForms		boolean	Indique si le champ que vous ajoutez doit apparaître sur les formulaires.
label	label	True	string	Étiquette (nom) du champ.
findEnabled	findEnabled		boolean	Indique si le champ est marqué comme pouvant faire l’objet d’une recherche.
noWrap	noWrap		boolean	Indique si le champ est configuré pour ne pas encapsuler lorsqu’il est affiché dans le produit.

Retours

Créer une réponse de champ: createFieldResponse

Créer une application

ID d’opération :: CreateApp

Crée une application dans un compte. Vous devez disposer de droits de création d’application dans le compte respectif. Les propriétés principales et les variables d’application peuvent être définies avec cette API.

Paramètres

Nom	Clé	Obligatoire	Type	Description
assignToken	assignToken		boolean	Définissez la valeur true si vous souhaitez affecter l’application au jeton utilisateur que vous avez utilisé pour créer l’application. La valeur par défaut est false.
nom	name	True	string	Nom de la variable.
value	value	True	string	Valeur de la variable.
nom	name	True	string	Nom de l’application. Vous êtes autorisé à créer plusieurs applications portant le même nom, dans le même domaine, car elles auront des valeurs dbid différentes. Nous vous recommandons d’être prudent pour ce faire.
descriptif	description		string	Description de l’application. Si cette propriété est laissée hors service, la description de l’application est vide.

Retours

Créer une réponse d’application: createAppResponse

Créer une relation

ID d’opération :: CreateRelationship

Crée une relation dans une table ainsi que des champs de recherche/résumé. Les relations ne peuvent être créées que pour les tables au sein de la même application.

Paramètres

Nom	Clé	Obligatoire	Type	Description
summaryFid	summaryFid		double	ID de champ à résumer.
label	label		string	Étiquette du champ résumé.
AccumulationType	accumulationType	True	string	Type d’accumulation pour le champ récapitulative.
where	where		string	Filtre, à l’aide du langage de requête Quickbase, qui détermine les enregistrements à retourner.
lookupFieldIds	lookupFieldIds		array of integer	Tableau d’ID de champ dans la table parente qui deviendra des champs de recherche dans la table enfant.
parentTableId	parentTableId	True	string	ID de table parent pour la relation.
label	label		string	Étiquette du champ de clé étrangère.
Table ID	tableId	True	string	Identificateur unique (DBID) de la table. Il s’agit de la table enfant.

Retours

Créer une réponse de relation: createRelationshipResponse

Créer une table

ID d’opération :: CreateTable

Crée une table dans une application.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID d’application	appId	True	string	Identificateur unique d’une application
nom	name	True	string	Nom de la table.
pluralRecordName	pluralRecordName		string	Nom pluriel pour les enregistrements de la table. Si cette valeur n’est pas passée, la valeur par défaut est « Enregistrements ».
singleRecordName	singleRecordName		string	Nom singulier pour les enregistrements de la table. Si cette valeur n’est pas passée, la valeur par défaut est « Record ».
descriptif	description		string	Description de la table. Si cette valeur n’est pas passée, la valeur par défaut est vide.

Retours

Créer une réponse de table: createTableResponse

Désactiver un jeton utilisateur

ID d’opération :: DeactivateUserToken

Désactive le jeton utilisateur authentifié. Une fois cette opération terminée, le jeton utilisateur doit être réactivé dans l’interface utilisateur.

Retours

Nom	Chemin d’accès	Type	Description
pièce d'identité	id	integer	pièce d'identité

Exécuter un rapport

ID d’opération :: RunReport

Exécute un rapport, en fonction d’un ID et retourne les données sous-jacentes associées. Le format des données varie en fonction du type de rapport. Les rapports qui se concentrent sur les données au niveau de l’enregistrement (table, calendrier, etc.) retournent les enregistrements individuels. Les rapports agrégés (résumé, graphique) retournent les informations résumées comme configurés dans le rapport. Les éléments spécifiques à l’interface utilisateur ne sont pas retournés, tels que les totaux, les moyennes et les visualisations. Retourne des données avec pagination intelligente en fonction de la taille approximative de chaque enregistrement. L’objet de métadonnées inclut les informations nécessaires pour itérer sur la réponse et collecter plus de données.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Table ID	tableId	True	string	Identificateur de la table pour le rapport.
Ignorer	skip		integer	Nombre d’enregistrements à ignorer. Vous pouvez définir cette valeur lors de la pagination via un ensemble de résultats.
Haut	top		integer	Nombre maximal d’enregistrements à retourner. Vous pouvez remplacer la pagination Quickbase par défaut pour obtenir plus ou moins de résultats. Si votre valeur demandée ici dépasse les maximums dynamiques, nous retournerons un sous-ensemble de résultats et le reste peut être collecté dans les appels d’API suivants.
			object
ID du rapport	reportId	True	string	Identificateur du rapport, unique à la table.

Retours

Exécuter la réponse du rapport: runReportResponse

Exécuter une formule

ID d’opération :: RunFormula

Autorise l’exécution d’une formule via un appel d’API. Utilisez cette méthode dans le code personnalisé pour récupérer la valeur d’une formule sans champ discret sur un enregistrement.

Paramètres

Nom	Clé	Obligatoire	Type	Description
formule	formula	True	string	Formule à exécuter. Il doit s’agir d’une formule Quickbase valide.
débarrasser	rid		integer	ID d’enregistrement sur lequel exécuter la formule. Nécessaire uniquement pour les formules exécutées dans le contexte d’un enregistrement. Par exemple, la formule User() n’a pas besoin d’un ID d’enregistrement.
de	from	True	string	Identificateur unique (dbid) de la table.

Retours

Exécuter la réponse de formule: runFormulaResponse

Insérer des enregistrements de mise à jour andor

ID d’opération :: UpsertRecords

Insérez et/ou mettez à jour des enregistrements dans une table. Dans cet appel d’API unique, les insertions et les mises à jour peuvent être envoyées. La mise à jour peut utiliser le champ clé sur la table ou tout autre champ unique pris en charge. Pour plus d’informations sur la façon dont chaque type de champ doit être mis en forme, reportez-vous à la page Types de champs. Cette opération permet un traitement incrémentiel des enregistrements réussis, même en cas d’échec de certains enregistrements.
Note: Ce point de terminaison prend en charge une taille maximale de charge utile de 10 Mo.

Paramètres

Nom	Clé	Obligatoire	Type	Description
à	to	True	string	Identificateur de table.
données	data		object
mergeFieldId	mergeFieldId		integer	ID du champ de fusion.
fieldsToReturn	fieldsToReturn		array of integer	Spécifiez un tableau d’ID de champ qui retourne des données pour toutes les mises à jour ou enregistrements ajoutés. L’ID d’enregistrement (FID 3) est toujours retourné si un ID de champ est demandé.

Retours

Réponse réussie qui inclut des détails sur les enregistrements ajoutés, mis à jour ou inchangés. Dans l’exemple ci-dessous, le tableau comportait auparavant dix enregistrements avec des ID de 1 à 10. L’utilisateur publie un upsert qui met à jour la valeur de l’enregistrement 1 et ajoute deux nouveaux enregistrements, tous avec succès.

Réponse Upsert: upsertResponse

Mettre à jour un champ

ID d’opération :: UpdateField

Met à jour les propriétés et les autorisations personnalisées d’un champ. La tentative de mise à jour de certaines propriétés peut entraîner la non-respect des nouvelles propriétés du champ et peut être rejetée. Consultez les descriptions des éléments requis, uniques et choix, ci-dessous, pour connaître des situations spécifiques. Toutes les propriétés du champ que vous ne spécifiez pas dans le corps de la demande restent inchangées.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Table ID	tableId	True	string	Identificateur unique de la table.
Vérifiés	audited		boolean	Indique si le champ est suivi dans le cadre des journaux d’audit De base rapide. Vous ne pouvez définir cette propriété que sur « true » si l’application a activé les journaux d’audit. Consultez Activer les journaux de modification des données sous Journaux d’audit De base rapide.
fieldHelp	fieldHelp		string	Texte d’aide configuré affiché aux utilisateurs du produit.
audacieux	bold		boolean	Indique si le champ est configuré pour s’afficher en gras dans le produit.
obligatoire	required		boolean	Indique si le champ est requis (c’est-à-dire si chaque enregistrement doit avoir une valeur non null dans ce champ). Si vous tentez de modifier un champ de non obligatoire à obligatoire et que la table contient actuellement des enregistrements qui ont des valeurs Null dans ce champ, vous obtenez une erreur indiquant qu’il existe des valeurs Null du champ. Dans ce cas, vous devez rechercher et mettre à jour ces enregistrements avec des valeurs Null du champ avant de modifier le champ en fonction des besoins.
comments	comments		string	Commentaires entrés sur les propriétés de champ par un administrateur.
doesTotal	doesTotal		boolean	Indique si ce champ est total dans les rapports au sein du produit.
enregistrement automatique	autoSave		boolean	Indique si le champ de lien est automatiquement enregistré.
defaultValueLuid	defaultValueLuid		integer	Valeur d’ID d’utilisateur par défaut.
maxVersions	maxVersions		integer	Nombre maximal de versions configurées pour une pièce jointe de fichier.
format	format		integer	Format à afficher l’heure.
carryChoices	carryChoices		boolean	Indique si le champ doit contenir ses champs de choix multiples lors de la copie.
longueur maximale	maxLength		integer	Nombre maximal de caractères autorisés pour l’entrée dans Quickbase pour ce champ.
linkText	linkText		string	Valeur de texte configurée qui remplace l’URL que les utilisateurs voient dans le produit.
parentFieldId	parentFieldId		integer	ID du champ composite parent, le cas échéant.
displayTimezone	displayTimezone		boolean	Indique s’il faut afficher le fuseau horaire dans le produit.
summaryTargetFieldId	summaryTargetFieldId		integer	ID du champ utilisé pour agréger les valeurs de l’enfant, le cas échéant. Cela s’affiche 0 si la fonction récapitulative ne nécessite pas de sélection de champ (comme le nombre).
allowNewChoices	allowNewChoices		boolean	Indique si les utilisateurs peuvent ajouter de nouveaux choix à une liste de sélection.
defaultToday	defaultToday		boolean	Indique si la valeur du champ est définie par défaut aujourd’hui pour les nouveaux enregistrements.
Unités	units		string	Étiquette d’unités.
lookupTargetFieldId	lookupTargetFieldId		integer	ID du champ qui est la cible de la table parente pour cette recherche.
SummaryFunction3	summaryFunction		string	Type d’accumulation pour le champ récapitulative.
sourceFieldId	sourceFieldId		integer	ID du champ source.
doesAverage	doesAverage		boolean	Indique si ce champ est moyen dans les rapports au sein du produit.
formule	formula		string	Formule du champ tel qu’il est configuré dans Quickbase.
Décimales	decimalPlaces		integer	Nombre de décimales affichées dans le produit pour ce champ.
displayMonth	displayMonth		string	Comment afficher des mois.
seeVersions	seeVersions		boolean	Indique si l’utilisateur peut voir d’autres versions, à l’exception de la plus récente, d’une pièce jointe de fichier dans le produit.
numLines	numLines		integer	Nombre de lignes affichées dans Quickbase pour ce champ de texte.
defaultKind	defaultKind		string	Type par défaut de l’utilisateur.
displayEmail	displayEmail		string	Affichage de l’e-mail.
coverText	coverText		string	Texte convivial de remplacement qui peut être utilisé pour afficher un lien dans le navigateur.
currencySymbol	currencySymbol		string	Symbole actuel utilisé lors de l’affichage des valeurs de champ dans le produit.
summaryQuery	summaryQuery		string	Requête récapitulative.
targetFieldId	targetFieldId		integer	ID du champ cible.
displayUser	displayUser		string	Option configurée pour la façon dont les utilisateurs s’affichent dans le produit.
blankIsZero	blankIsZero		boolean	Indique si une valeur vide est traitée comme 0 dans les calculs au sein du produit.
exact	exact		boolean	Indique si une correspondance exacte est requise pour un lien de rapport.
defaultDomain	defaultDomain		string	Domaine de messagerie par défaut.
defaultValue	defaultValue		string	Valeur par défaut configurée pour un champ lorsqu’un nouvel enregistrement est ajouté.
abréger	abbreviate		boolean	N’affichez pas le protocole d’URL lors de l’affichage de l’URL.
formatNombre	numberFormat		integer	Format utilisé pour afficher des valeurs numériques dans le produit (décimal, séparateurs, groupe de chiffres).
targetTableName	targetTableName		string	Nom de la table cible du champ.
appearsAs	appearsAs		string	Le texte du lien, s’il est vide, l’URL sera utilisée comme texte de lien.
width	width		integer	Largeur d’entrée html du champ dans le produit.
CurrencyFormat	currencyFormat		string	Format monétaire utilisé lors de l’affichage des valeurs de champ dans le produit.
displayImages	displayImages		boolean	Indique si les images s’affichent pour les pièces jointes de fichiers sur les formulaires et les rapports au sein du produit.
displayDayOfWeek	displayDayOfWeek		boolean	Indique s’il faut afficher le jour de la semaine dans le produit.
summaryReferenceFieldId	summaryReferenceFieldId		integer	ID du champ qui est la référence dans la relation pour ce résumé.
virguleStart	commaStart		integer	Nombre de chiffres avant l’affichage des virgules dans le produit, le cas échéant.
choices	choices		array of string	Tableau d’entrées qui existent pour un champ qui offre des choix à l’utilisateur. Notez que ces choix font référence aux valeurs valides des enregistrements ajoutés à l’avenir. Vous êtes autorisé à supprimer des valeurs de la liste des choix, même s’il existe des enregistrements existants avec ces valeurs dans ce champ. Ils seront affichés en rouge lorsque les utilisateurs examinent les données dans le navigateur, mais il n’y a aucun autre effet. Lors de la mise à jour d’un champ avec cette propriété, les anciens choix sont supprimés et remplacés par les nouveaux choix.
targetTableId	targetTableId		string	ID de la table cible.
displayRelative	displayRelative		boolean	Indique s’il faut afficher l’heure en tant que relative.
compositeFields	compositeFields		object
summaryTableId	summaryTableId		string	Tableau à partir duquel le champ récapitulative fait référence aux champs.
displayTime	displayTime		boolean	Indique s’il faut afficher l’heure, en plus de la date.
VersionMode	versionMode		string	Modes de version pour les fichiers. Conservez toutes les versions et conservez la dernière version.
snapFieldId	snapFieldId		integer	ID du champ utilisé pour les valeurs d’instantané, le cas échéant.
heures24	hours24		boolean	Indique s’il faut afficher l’heure dans le format de 24 heures dans le produit.
sortAlpha	sortAlpha		boolean	Indique s’il faut trier par ordre alphabétique, le tri par défaut est par ID d’enregistrement.
sortAsGiven	sortAsGiven		boolean	Indique si les entrées répertoriées trient comme entrées par ordre alphabétique.
hasExtension	hasExtension		boolean	Indique si ce champ a une extension de téléphone.
useNewWindow	useNewWindow		boolean	Indique si l’URL doit ouvrir une nouvelle fenêtre lorsqu’un utilisateur clique dessus dans le produit.
appendOnly	appendOnly		boolean	Indique si ce champ est ajouté uniquement.
displayAsLink	displayAsLink		boolean	Indique si un champ qui fait partie de la relation doit être affiché en tant que lien hypertexte vers l’enregistrement parent dans le produit.
lookupReferenceFieldId	lookupReferenceFieldId		integer	ID du champ qui est la référence dans la relation pour cette recherche.
appearsByDefault	appearsByDefault		boolean	Indique si le champ est marqué comme valeur par défaut dans les rapports.
unique	unique		boolean	Indique si chaque enregistrement de la table doit contenir une valeur unique de ce champ. Si vous tentez de modifier un champ non unique en un seul et que la table contient actuellement des enregistrements avec la même valeur de ce champ, vous obtiendrez une erreur. Dans ce cas, vous devez rechercher et mettre à jour ces enregistrements avec des valeurs dupliquées du champ avant de changer le champ en un seul.
role	role		string	Rôle associé à une autorisation donnée pour le champ
permissionType	permissionType		string	Autorisation donnée au rôle pour ce champ
roleId	roleId		integer	ID du rôle donné
addToForms	addToForms		boolean	Indique si le champ que vous ajoutez doit apparaître sur les formulaires.
label	label		string	Étiquette (nom) du champ.
findEnabled	findEnabled		boolean	Indique si le champ est marqué comme pouvant faire l’objet d’une recherche.
noWrap	noWrap		boolean	Indique si le champ est configuré pour ne pas encapsuler lorsqu’il est affiché dans le produit.
ID de champ	fieldId	True	integer	Identificateur unique (FID) du champ.

Retours

Mettre à jour la réponse du champ: updateFieldResponse

Mettre à jour une application

ID d’opération :: UpdateApp

Met à jour les principales propriétés et/ou variables d’application pour une application spécifique. Toutes les propriétés de l’application que vous ne spécifiez pas dans le corps de la requête restent inchangées.

Paramètres

Nom	Clé	Obligatoire	Type	Description
nom	name	True	string	Nom de la variable.
value	value	True	string	Valeur de la variable.
nom	name		string	Nom de l’application.
descriptif	description		string	Description de l’application.
ID d’application	appId	True	string	Identificateur unique d’une application.

Retours

Mettre à jour la réponse de l’application: updateAppResponse

Mettre à jour une relation

ID d’opération :: UpdateRelationship

Utilisez ce point de terminaison pour ajouter des champs de recherche et des champs récapitulatives à une relation existante. La mise à jour d’une relation ne supprime pas les champs de recherche/résumé existants.

Paramètres

Nom	Clé	Obligatoire	Type	Description
summaryFid	summaryFid		double	ID de champ à résumer.
label	label		string	Étiquette du champ résumé.
AccumulationType	accumulationType	True	string	Type d’accumulation pour le champ récapitulative.
where	where		string	Filtre, à l’aide du langage de requête Quickbase, qui détermine les enregistrements à retourner.
lookupFieldIds	lookupFieldIds		array of integer	Tableau d’ID de champ sur la table parente qui deviendra des champs de recherche sur la table enfant.
Table ID	tableId	True	string	Identificateur unique (DBID) de la table. Il s’agit de la table enfant.
ID de relation	relationshipId	True	double	ID de relation. Il s’agit de l’ID de champ du champ de référence sur la table enfant.

Retours

Mettre à jour la réponse de relation: updateRelationshipResponse

Mettre à jour une table

ID d’opération :: UpdateTable

Met à jour les propriétés principales d’une table spécifique. Toutes les propriétés de la table que vous ne spécifiez pas dans le corps de la requête restent inchangées.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID d’application	appId	True	string	Identificateur unique d’une application
nom	name		string	Nom de la table.
pluralRecordName	pluralRecordName		string	Nom pluriel pour les enregistrements de la table. Si cette valeur n’est pas passée, la valeur par défaut est « Enregistrements ».
singleRecordName	singleRecordName		string	Nom singulier pour les enregistrements de la table. Si cette valeur n’est pas passée, la valeur par défaut est « Record ».
descriptif	description		string	Description de la table. Si cette valeur n’est pas passée, la valeur par défaut est vide.
Table ID	tableId	True	string	Identificateur unique (DBID) de la table.

Retours

Mettre à jour la réponse de table: updateTableResponse

Obtenir des champs pour une table

ID d’opération :: GetFields

Obtient les propriétés de tous les champs d’une table spécifique. Les propriétés de chaque champ sont identiques à celles du champ Get.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Table ID	tableId	True	string	Identificateur unique (DBID) de la table.
Inclure des autorisations de champ	includeFieldPerms		boolean	Définissez la valeur « true » si vous souhaitez récupérer les autorisations personnalisées pour le ou les champs.

Retours

Nom	Chemin d’accès	Type	Description
		array of object
ID	id	integer	Identificateur.
Étiquette	label	string	Étiquette.
Type de champ	fieldType	string	Type de champ.
Aucun wrapper	noWrap	boolean	S’il n’y a pas de wrap.
Bold	bold	boolean	Indique si la valeur est en gras.
Obligatoire	required	boolean	Indique si nécessaire.
S’affiche par défaut	appearsByDefault	boolean	Indique si elle apparaît par défaut.
Rechercher activé	findEnabled	boolean	Indique si la recherche est activée.
Unique	unique	boolean	Indique s’il s’agisse d’une valeur
Copie des données	doesDataCopy	boolean	Indique si les données sont copiées.
Aide sur le champ	fieldHelp	string	Aide sur le champ.
Vérifiés	audited	boolean	Indique si l’audit est fait.
Clé primaire	properties.primaryKey	boolean	Indique si la clé primaire.
Clé étrangère	properties.foreignKey	boolean	Indique si la clé étrangère.
Nombre de lignes	properties.numLines	integer	Nombre de lignes.
Longueur maximale	properties.maxLength	integer	Longueur maximale.
Ajouter uniquement	properties.appendOnly	boolean	Indique si l’ajout est uniquement.
allowHTML	properties.allowHTML	boolean	Indique s’il faut autoriser le code HTML.
Trier comme donné	properties.sortAsGiven	boolean	Indique si le tri est donné.
Choix de transport	properties.carryChoices	boolean	S’il faut faire des choix.
Autoriser les nouveaux choix	properties.allowNewChoices	boolean	Indique s’il faut autoriser de nouveaux choix.
Formula	properties.formula	string	Formule.
Valeur par défaut	properties.defaultValue	string	Valeur par défaut.
Format numérique	properties.numberFormat	integer	Format numérique.
Décimales	properties.decimalPlaces	integer	Décimales.
Fait moyenne	properties.doesAverage	boolean	Indique s’il s’agisse d’une moyenne.
Does Total	properties.doesTotal	boolean	Indique si le total est total.
Vide est zéro	properties.blankIsZero	boolean	Indique si le champ vide est égal à zéro.
Permissions	permissions	array of object
Type d’autorisation	permissions.permissionType	string	Type d’autorisation.
Role	permissions.role	string	Rôle.
ID de rôle	permissions.roleId	integer	Identificateur du rôle.
Ajouter aux formulaires	addToForms	boolean	Indique s’il faut ajouter des formulaires.

Obtenir des tables pour une application

ID d’opération :: GetAppTables

Obtient une liste de toutes les tables qui existent dans une application spécifique. Les propriétés de chaque table sont identiques à celles retournées dans La table Get.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID d’application	appId	True	string	Identificateur unique d’une application

Retours

Nom	Chemin d’accès	Type	Description
		array of object
Nom	name	string	Nom.
Créé	created	string	Lors de la création.
Updated	updated	string	En cas de mise à jour.
Alias	alias	string	Alias.
Descriptif	description	string	Description.
ID	id	string	Identificateur.
ID d’enregistrement suivant	nextRecordId	integer	Identificateur de l’enregistrement suivant.
ID de champ suivant	nextFieldId	integer	Identificateur du champ suivant.
ID de champ de tri par défaut	defaultSortFieldId	integer	Identificateur du champ de tri par défaut.
Ordre de tri par défaut	defaultSortOrder	string	Ordre de tri par défaut.
ID de champ de clé	keyFieldId	integer	Identificateur du champ de clé.
Nom d’enregistrement unique	singleRecordName	string	Nom de l’enregistrement unique.
Nom de l’enregistrement plural	pluralRecordName	string	Nom de l’enregistrement pluriel.
Limite de taille	sizeLimit	string	Limite de taille.
Espace utilisé	spaceUsed	string	Espace utilisé.
Espace restant	spaceRemaining	string	Espace restant.

Obtenir des événements d’application

ID d’opération :: GetAppEvents

Obtenez la liste des événements qui peuvent être déclenchés en fonction des données ou des actions utilisateur de cette application, notamment : notification par e-mail, rappels, abonnements, actions QB, webhooks, enregistrement des automatisations déclenchées par modification (n’inclut pas d’automatisation planifiée).

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID d’application	appId	True	string	Identificateur unique d’une application.

Retours

Nom	Chemin d’accès	Type	Description
		array of object
Type	type	string	Type.
Messagerie électronique	owner.email	string	Adresse e-mail du propriétaire.
ID	owner.id	string	Identificateur du propriétaire.
Nom	owner.name	string	Nom du propriétaire.
Nom d'utilisateur	owner.userName	string	Nom d’utilisateur du propriétaire.
Est actif	isActive	boolean	Indique s’il est actif.
Table ID	tableId	string	Identificateur de la table.
Nom	name	string	Nom.
URL	url	string	Adresse URL.

Obtenir le champ

ID d’opération :: GetField

Obtient les propriétés d’un champ individuel, en fonction de l’ID de champ.
Les propriétés présentes sur tous les types de champs sont retournées au niveau supérieur. Les propriétés propres à un type de champ spécifique sont retournées sous l’attribut « properties ». Pour plus d’informations sur les propriétés de chaque type de champ, consultez la page Types de champs.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Table ID	tableId	True	string	Identificateur unique (DBID) de la table.
Inclure des autorisations de champ	includeFieldPerms		boolean	Définissez la valeur « true » si vous souhaitez récupérer les autorisations personnalisées pour le ou les champs.
ID de champ	fieldId	True	integer	Identificateur unique (FID) du champ.

Retours

Obtenir la réponse de champ: getFieldResponse

Obtenir l’utilisation de tous les champs

ID d’opération :: GetFieldsUsage

Obtenez toutes les statistiques d’utilisation des champs pour une table. Il s’agit d’un résumé des informations disponibles dans la table d’utilisation des propriétés de champ.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Table ID	tableId	True	string	Identificateur unique (DBID) de la table.
Ignorer	skip		integer	Nombre de champs à ignorer dans la liste.
Haut	top		integer	Nombre maximal de champs à retourner.

Retours

Nom	Chemin d’accès	Type	Description
		array of object
ID	field.id	integer	Identificateur.
Nom	field.name	string	Nom.
Type	field.type	string	Type.
Nombre	usage.actions.count	integer	Nombre.
Nombre	usage.appHomePages.count	integer	Nombre.
Nombre	usage.defaultReports.count	integer	Nombre.
Nombre	usage.exactForms.count	integer	Nombre.
Nombre	usage.fields.count	integer	Nombre.
Nombre	usage.forms.count	integer	Nombre.
Nombre	usage.notifications.count	integer	Nombre.
Nombre	usage.personalReports.count	integer	Nombre.
Nombre	usage.relationships.count	integer	Nombre.
Nombre	usage.reminders.count	integer	Nombre.
Nombre	usage.reports.count	integer	Nombre.
Nombre	usage.roles.count	integer	Nombre.
Nombre	usage.webhooks.count	integer	Nombre.

Obtenir tous les rapports de table

ID d’opération :: GetTableReports

Obtenez le schéma (propriétés) de tous les rapports d’une table. Si l’utilisateur exécutant l’API est administrateur d’application, l’API retourne également tous les rapports personnels avec l’ID d’utilisateur du propriétaire.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Table ID	tableId	True	string	Identificateur unique de la table.

Retours

Nom	Chemin d’accès	Type	Description
		array of object
ID	id	string	Identificateur.
Nom	name	string	Nom.
Type	type	string	Type.
Descriptif	description	string	Description.
ID du propriétaire	ownerId	string	Identificateur du propriétaire.
Dernière utilisation	usedLast	string	Lorsqu’il est utilisé en dernier.
Nombre utilisé	usedCount	integer	Nombre utilisé.

Obtenir toutes les relations

ID d’opération :: GetRelationships

Obtenez une liste de toutes les relations et de leurs définitions pour une table spécifique. Les détails sont fournis à la fois pour les côtés parent et enfant des relations au sein d’une application donnée. Des détails limités sont retournés pour les relations entre applications.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Ignorer	skip		integer	Nombre de relations à ignorer.
Table ID	tableId	True	string	Identificateur unique (DBID) de la table.

Retours

Obtenir la réponse aux relations: getRelationshipsResponse

Obtenir un jeton temporaire pour un DBID

ID d’opération :: GetTempTokenDBID

Utilisez ce point de terminaison pour obtenir un jeton d’autorisation temporaire, limité à une application ou à une table. Vous pouvez ensuite utiliser ce jeton pour effectuer d’autres appels d’API (voir autorisation). Ce jeton expire dans 5 minutes.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Jeton d’application	QB-App-Token		string	Votre jeton d’application Quickbase
DBID	dbid	True	string	Identificateur unique d’une application ou d’une table.

Retours

getTempTokenDBIDResponse: getTempTokenDBIDResponse

Obtenir un rapport

ID d’opération :: GetReport

Obtenez le schéma (propriétés) d’un rapport individuel.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Table ID	tableId	True	string	Identificateur unique de la table.
ID du rapport	reportId	True	string	Identificateur du rapport, unique à la table.

Retours

Obtenir une réponse de rapport: getReportResponse

Obtenir une application

ID d’opération :: GetApp

Retourne les propriétés principales d’une application, y compris les variables d’application.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID d’application	appId	True	string	Identificateur unique d’une application.

Retours

Obtenir la réponse de l’application: getAppResponse

Obtenir une table

ID d’opération :: GetTable

Obtient les propriétés d’une table individuelle qui fait partie d’une application.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID d’application	appId	True	string	Identificateur unique d’une application
Table ID	tableId	True	string	Identificateur unique (DBID) de la table.

Retours

Obtenir la réponse de table: getTableResponse

Obtenir une utilisation de champ

ID d’opération :: GetFieldUsage

Obtenez des statistiques d’utilisation de champs uniques. Il s’agit d’un résumé des informations disponibles dans la table d’utilisation des propriétés de champ.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Table ID	tableId	True	string	Identificateur unique (DBID) de la table.
ID de champ	fieldId	True	integer	Identificateur unique (FID) du champ.

Retours

Nom	Chemin d’accès	Type	Description
		array of object
ID	field.id	integer	Identificateur.
Nom	field.name	string	Nom.
Type	field.type	string	Type.
Nombre	usage.actions.count	integer	Nombre.
Nombre	usage.appHomePages.count	integer	Nombre.
Nombre	usage.defaultReports.count	integer	Nombre.
Nombre	usage.exactForms.count	integer	Nombre.
Nombre	usage.fields.count	integer	Nombre.
Nombre	usage.forms.count	integer	Nombre.
Nombre	usage.notifications.count	integer	Nombre.
Nombre	usage.personalReports.count	integer	Nombre.
Nombre	usage.relationships.count	integer	Nombre.
Nombre	usage.reminders.count	integer	Nombre.
Nombre	usage.reports.count	integer	Nombre.
Nombre	usage.roles.count	integer	Nombre.
Nombre	usage.webhooks.count	integer	Nombre.

Rechercher des données

ID d’opération :: RunQuery

Transmettez une requête dans le langage de requête Quickbase. Retourne des données d’enregistrement avec pagination intelligente en fonction de la taille approximative de chaque enregistrement. L’objet de métadonnées inclut les informations nécessaires pour itérer sur la réponse et collecter plus de données.

Paramètres

Nom	Clé	Obligatoire	Type	Description
skip	skip		integer	Nombre d’enregistrements à ignorer.
compareWithAppLocalTime	compareWithAppLocalTime		boolean	Indique s’il faut exécuter la requête sur un champ d’heure de date par rapport à l’heure locale de l’application. La requête est exécutée avec l’heure UTC par défaut.
top	top		integer	Nombre maximal d’enregistrements à afficher.
where	where		string	Filtre, à l’aide du langage de requête Quickbase, qui détermine les enregistrements à retourner. Si ce paramètre est omis, la requête retourne tous les enregistrements.
fieldId	fieldId		integer	Identificateur unique d’un champ dans une table.
Grouping	grouping		string	Regrouper en fonction de l’ordre croissant (ASC), de l’ordre décroissant (DESC) ou des valeurs égales (valeurs égales)
sortBy	sortBy		object	Par défaut, les requêtes sont triées par les champs de tri donnés ou le tri par défaut si la requête ne fournit aucun élément. Définissez la valeur false pour éviter le tri lorsque l’ordre des données retournées n’est pas important. Le renvoi de données sans tri peut améliorer les performances.
select	select		object
de	from	True	string	Identificateur de table.

Retours

Exécuter la réponse aux requêtes: runQueryResponse

Suppression d’une table

ID d’opération :: DeleteTable

Supprime une table spécifique dans une application, y compris toutes les données qu’elle contient.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID d’application	appId	True	string	Identificateur unique d’une application
Table ID	tableId	True	string	Identificateur unique (DBID) de la table.

Retours

Supprimer la réponse de table: deleteTableResponse

Supprimer des champs

ID d’opération :: DeleteFields

Supprime un ou plusieurs champs d’une table, en fonction de l’ID de champ. Cela supprime également définitivement toutes les données ou calculs de ce champ.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Table ID	tableId	True	string	Identificateur unique de la table.
fieldIds	fieldIds	True	array of integer	Liste des ID de champ à supprimer.

Retours

Supprimer la réponse des champs: deleteFieldsResponse

Supprimer des enregistrements

ID d’opération :: DeleteRecords

Supprime les enregistrements d’une table en fonction d’une requête. Vous pouvez également supprimer tous les enregistrements de la table.

Paramètres

Nom	Clé	Obligatoire	Type	Description
de	from	True	string	Identificateur unique de la table.
where	where	True	string	Filtre pour supprimer des enregistrements. Pour supprimer tous les enregistrements, spécifiez un filtre qui inclut tous les enregistrements, par exemple {3.GT.0} où 3 est l’ID du champ ID d’enregistrement.

Retours

Supprimer la réponse aux enregistrements: deleteRecordsResponse

Supprimer un jeton utilisateur

ID d’opération :: DeleteUserToken

Supprime le jeton d’utilisateur authentifié. Ce n’est pas réversible.

Retours

Supprimer la réponse du jeton utilisateur: deleteUserTokenResponse

Supprimer une application

ID d’opération :: DeleteApp

Supprime une application entière, y compris toutes les tables et données.

Paramètres

Nom	Clé	Obligatoire	Type	Description
nom	name	True	string	Pour confirmer la suppression de l’application, nous demandons le nom de l’application.
ID d’application	appId	True	string	Identificateur unique d’une application.

Retours

Supprimer la réponse de l’application: deleteAppResponse

Supprimer une pièce jointe

ID d’opération :: DeleteFile

Supprime une version de pièce jointe de fichier. Les métadonnées sur les fichiers peuvent être récupérées à partir des points de terminaison /records et /reports, le cas échéant. Utilisez ces points de terminaison pour obtenir les informations nécessaires pour supprimer les versions de fichiers.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Table ID	tableId	True	string	Identificateur unique de la table.
ID enregistrement	recordId	True	integer	Identificateur unique de l’enregistrement.
ID de champ	fieldId	True	integer	Identificateur unique du champ.
Numéro de version	versionNumber	True	integer	Numéro de version de la pièce jointe du fichier.

Retours

Supprimer la réponse du fichier: deleteFileResponse

Supprimer une relation

ID d’opération :: DeleteRelationship

Utilisez ce point de terminaison pour supprimer une relation entière, y compris tous les champs de recherche et de résumé. Le champ de référence de la relation ne sera pas supprimé.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Table ID	tableId	True	string	Identificateur unique (DBID) de la table. Il s’agit de la table enfant.
ID de relation	relationshipId	True	double	ID de relation. Il s’agit de l’ID de champ du champ de référence sur la table enfant.

Retours

Supprimer la réponse de relation: deleteRelationshipResponse

Télécharger une pièce jointe

ID d’opération :: DownloadFile

Télécharge la pièce jointe du fichier, avec le contenu de pièce jointe encodé au format base64. La réponse de l’API retourne le nom du fichier dans l’en-tête Content-Disposition . Les métadonnées sur les fichiers peuvent être récupérées à partir des points de terminaison /records et /reports, le cas échéant. Utilisez ces points de terminaison pour obtenir les informations nécessaires pour extraire des fichiers.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Table ID	tableId	True	string	Identificateur unique de la table.
ID enregistrement	recordId	True	integer	Identificateur unique de l’enregistrement.
ID de champ	fieldId	True	integer	Identificateur unique du champ.
Numéro de version	versionNumber	True	integer	Numéro de version de la pièce jointe du fichier.

Retours

response: string

Définitions

createAppResponse

Nom	Chemin d’accès	Type	Description
nom	name	string	Nom de l’application. Vous êtes autorisé à créer plusieurs applications portant le même nom, dans le même domaine, car elles auront des valeurs dbid différentes. Nous vous recommandons d’être prudent pour ce faire.
descriptif	description	string	Description de l’application. Si cette propriété est laissée hors service, la description de l’application est vide.
créé	created	string	Heure et date de création de l’application, au format horaire ISO 8601 AAAA-MM-DDThh :mm :sssZ (dans le fuseau horaire UTC).
Actualisé	updated	string	Heure et date de la dernière mise à jour de l’application, au format d’heure ISO 8601 AAAA-MM-DDThh :mm :ssssZ (dans le fuseau horaire UTC).
dateFormat	dateFormat	string	Description du format utilisé lors de l’affichage des valeurs de date dans cette application. Notez qu’il s’agit d’un paramètre de navigateur uniquement : consultez la page détails du type de champ dans le Guide de l’API pour savoir comment les valeurs de temps sont retournées dans les appels d’API. Consultez À propos de la localisation des dates pour définir le format de date de l’application.
timeZone	timeZone	string	Description du fuseau horaire utilisé lors de l’affichage des valeurs de temps dans cette application. Notez qu’il s’agit d’un paramètre de navigateur uniquement : consultez la page détails du type de champ dans le portail pour savoir comment les valeurs de temps sont retournées dans les appels d’API. Consultez Définir le fuseau horaire pour l’application et le compte pour définir le fuseau horaire de l’application.
pièce d'identité	id	string	Identificateur unique pour cette application.
hasEveryoneOnTheInternet	hasEveryoneOnTheInternet	boolean	Indique si l’application inclut tout le monde sur l’accès Internet. Consultez Partage d’applications avec tout le monde sur Internet (EOTI).
variables	variables	array of Variable1	Variables d’application. Voir à propos des variables d’application
dataClassification	dataClassification	string	Étiquette de classification des données affectée à l’application. Si la classification des données n’est pas activée, elle ne sera pas retournée. Si la classification des données est activée, mais que l’application n’est pas étiquetée, nous renvoyons « Aucun ». Les étiquettes de classification des données peuvent être ajoutées dans la console d’administration par un administrateur de domaine pour les plans Platform+.

Variable1

Nom	Chemin d’accès	Type	Description
nom	name	string	Nom de la variable.
value	value	string	Valeur de variable.

getAppResponse

Nom	Chemin d’accès	Type	Description
nom	name	string	Nom de l’application. Vous êtes autorisé à créer plusieurs applications portant le même nom, dans le même domaine, car elles auront des valeurs dbid différentes. Nous vous recommandons d’être prudent pour ce faire.
descriptif	description	string	Description de l’application. Si cette propriété est laissée hors service, la description de l’application est vide.
créé	created	string	Heure et date de création de l’application, au format horaire ISO 8601 AAAA-MM-DDThh :mm :sssZ (dans le fuseau horaire UTC).
Actualisé	updated	string	Heure et date de la dernière mise à jour de l’application, au format d’heure ISO 8601 AAAA-MM-DDThh :mm :ssssZ (dans le fuseau horaire UTC).
dateFormat	dateFormat	string	Description du format utilisé lors de l’affichage des valeurs de date dans cette application. Notez qu’il s’agit d’un paramètre de navigateur uniquement : consultez la page détails du type de champ dans le Guide de l’API pour savoir comment les valeurs de temps sont retournées dans les appels d’API. Consultez À propos de la localisation des dates pour définir le format de date de l’application.
timeZone	timeZone	string	Description du fuseau horaire utilisé lors de l’affichage des valeurs de temps dans cette application. Notez qu’il s’agit d’un paramètre de navigateur uniquement : consultez la page détails du type de champ dans le portail pour savoir comment les valeurs de temps sont retournées dans les appels d’API. Consultez Définir le fuseau horaire pour l’application et le compte pour définir le fuseau horaire de l’application.
pièce d'identité	id	string	Identificateur unique pour cette application.
hasEveryoneOnTheInternet	hasEveryoneOnTheInternet	boolean	Indique si l’application inclut tout le monde sur l’accès Internet. Consultez Partage d’applications avec tout le monde sur Internet (EOTI).
variables	variables	array of Variable1	Variables d’application. Voir à propos des variables d’application
dataClassification	dataClassification	string	Étiquette de classification des données affectée à l’application. Si la classification des données n’est pas activée, elle ne sera pas retournée. Si la classification des données est activée, mais que l’application n’est pas étiquetée, nous renvoyons « Aucun ». Les étiquettes de classification des données peuvent être ajoutées dans la console d’administration par un administrateur de domaine pour les plans Platform+.

updateAppResponse

Nom	Chemin d’accès	Type	Description
nom	name	string	Nom de l’application. Vous êtes autorisé à créer plusieurs applications portant le même nom, dans le même domaine, car elles auront des valeurs dbid différentes. Nous vous recommandons d’être prudent pour ce faire.
descriptif	description	string	Description de l’application. Si cette propriété est laissée hors service, la description de l’application est vide.
créé	created	string	Heure et date de création de l’application, au format horaire ISO 8601 AAAA-MM-DDThh :mm :sssZ (dans le fuseau horaire UTC).
Actualisé	updated	string	Heure et date de la dernière mise à jour de l’application, au format d’heure ISO 8601 AAAA-MM-DDThh :mm :ssssZ (dans le fuseau horaire UTC).
dateFormat	dateFormat	string	Description du format utilisé lors de l’affichage des valeurs de date dans cette application. Notez qu’il s’agit d’un paramètre de navigateur uniquement : consultez la page détails du type de champ dans le Guide de l’API pour savoir comment les valeurs de temps sont retournées dans les appels d’API. Consultez À propos de la localisation des dates pour définir le format de date de l’application.
timeZone	timeZone	string	Description du fuseau horaire utilisé lors de l’affichage des valeurs de temps dans cette application. Notez qu’il s’agit d’un paramètre de navigateur uniquement : consultez la page détails du type de champ dans le portail pour savoir comment les valeurs de temps sont retournées dans les appels d’API. Consultez Définir le fuseau horaire pour l’application et le compte pour définir le fuseau horaire de l’application.
pièce d'identité	id	string	Identificateur unique pour cette application.
hasEveryoneOnTheInternet	hasEveryoneOnTheInternet	boolean	Indique si l’application inclut tout le monde sur l’accès Internet. Consultez Partage d’applications avec tout le monde sur Internet (EOTI).
variables	variables	array of Variable1	Variables d’application. Voir à propos des variables d’application
dataClassification	dataClassification	string	Étiquette de classification des données affectée à l’application. Si la classification des données n’est pas activée, elle ne sera pas retournée. Si la classification des données est activée, mais que l’application n’est pas étiquetée, nous renvoyons « Aucun ». Les étiquettes de classification des données peuvent être ajoutées dans la console d’administration par un administrateur de domaine pour les plans Platform+.

deleteAppResponse

Nom	Chemin d’accès	Type	Description
deletedAppId	deletedAppId	string	ID de l’application supprimée.

copyAppResponse

Nom	Chemin d’accès	Type	Description
nom	name	string	Nom de l’application. Vous êtes autorisé à créer plusieurs applications portant le même nom, dans le même domaine, car elles auront des valeurs dbid différentes. Nous vous recommandons d’être prudent pour ce faire.
descriptif	description	string	Description de l’application
créé	created	string	Heure et date de création de l’application, au format horaire ISO 8601 AAAA-MM-DDThh :mm :sssZ (dans le fuseau horaire UTC).
Actualisé	updated	string	Heure et date de la dernière mise à jour de l’application, au format d’heure ISO 8601 AAAA-MM-DDThh :mm :ssssZ (dans le fuseau horaire UTC).
dateFormat	dateFormat	string	Description du format utilisé lors de l’affichage des valeurs de date dans cette application. Notez qu’il s’agit d’un paramètre de navigateur uniquement : consultez la page détails du type de champ dans le Guide de l’API pour savoir comment les valeurs de temps sont retournées dans les appels d’API. Consultez À propos de la localisation des dates pour définir le format de date de l’application.
timeZone	timeZone	string	Description du fuseau horaire utilisé lors de l’affichage des valeurs de temps dans cette application. Notez qu’il s’agit d’un paramètre de navigateur uniquement : consultez la page détails du type de champ dans le portail pour savoir comment les valeurs de temps sont retournées dans les appels d’API. Consultez Définir le fuseau horaire pour l’application et le compte pour définir le fuseau horaire de l’application.
pièce d'identité	id	string	Identificateur unique pour cette application.
hasEveryoneOnTheInternet	hasEveryoneOnTheInternet	boolean	Indique si l’application inclut tout le monde sur l’accès Internet. Consultez Partage d’applications avec tout le monde sur Internet (EOTI).
variables	variables	array of Variable1	Variables d’application. Voir à propos des variables d’application
ancestorId	ancestorId	string	ID de l’application à partir de laquelle cette application a été copiée
dataClassification	dataClassification	string	Étiquette de classification des données affectée à l’application. Si la classification des données n’est pas activée, elle ne sera pas retournée. Si la classification des données est activée, mais que l’application n’est pas étiquetée, nous renvoyons « Aucun ». Les étiquettes de classification des données peuvent être ajoutées dans la console d’administration par un administrateur de domaine pour les plans Platform+.

createTableResponse

Nom	Chemin d’accès	Type	Description
nom	name	string	Nom de la table.
pièce d'identité	id	string	Identificateur unique (dbid) de la table.
alias	alias	string	Alias de table créé automatiquement pour la table.
descriptif	description	string	Description de la table, telle qu’elle est configurée par un administrateur d’application.
créé	created	string	Heure et date de création de la table, au format d’heure ISO 8601 AAAA-MM-DDThh :mm :ssszZ (dans le fuseau horaire UTC).
Actualisé	updated	string	Heure et date de la dernière mise à jour du schéma ou des données de la table, au format d’heure ISO 8601 AAAA-MM-DDThh :mm :sssZ (dans le fuseau horaire UTC).
nextRecordId	nextRecordId	integer	ID d’enregistrement incrémentiel qui sera utilisé lors de la création de l’enregistrement suivant, tel que déterminé lors de l’exécution de l’appel d’API.
nextFieldId	nextFieldId	integer	ID de champ incrémentiel qui sera utilisé lors de la création du champ suivant, comme déterminé lors de l’exécution de l’appel d’API.
defaultSortFieldId	defaultSortFieldId	integer	ID du champ configuré pour le tri par défaut.
DefaultSortOrder	defaultSortOrder	DefaultSortOrder	Configuration de l’ordre de tri par défaut sur la table.
keyFieldId	keyFieldId	integer	ID du champ configuré pour être la clé de cette table, qui est généralement l’ID d’enregistrement Quickbase.
singleRecordName	singleRecordName	string	Nom unique configuré par le générateur de la table.
pluralRecordName	pluralRecordName	string	Nom pluriel configuré par le générateur de la table.
sizeLimit	sizeLimit	string	Limite de taille pour la table.
spaceUsed	spaceUsed	string	Quantité d’espace actuellement utilisée par la table.
spaceRemaining	spaceRemaining	string	Quantité d’espace restant à utiliser par la table.

DefaultSortOrder

Configuration de l’ordre de tri par défaut sur la table.

DefaultSortOrder: string

getTableResponse

Nom	Chemin d’accès	Type	Description
nom	name	string	Nom de la table.
pièce d'identité	id	string	Identificateur unique (dbid) de la table.
alias	alias	string	Alias de table créé automatiquement pour la table.
descriptif	description	string	Description de la table, telle qu’elle est configurée par un administrateur d’application.
créé	created	string	Heure et date de création de la table, au format d’heure ISO 8601 AAAA-MM-DDThh :mm :ssszZ (dans le fuseau horaire UTC).
Actualisé	updated	string	Heure et date de la dernière mise à jour du schéma ou des données de la table, au format d’heure ISO 8601 AAAA-MM-DDThh :mm :sssZ (dans le fuseau horaire UTC).
nextRecordId	nextRecordId	integer	ID d’enregistrement incrémentiel qui sera utilisé lors de la création de l’enregistrement suivant, tel que déterminé lors de l’exécution de l’appel d’API.
nextFieldId	nextFieldId	integer	ID de champ incrémentiel qui sera utilisé lors de la création du champ suivant, comme déterminé lors de l’exécution de l’appel d’API.
defaultSortFieldId	defaultSortFieldId	integer	ID du champ configuré pour le tri par défaut.
DefaultSortOrder	defaultSortOrder	DefaultSortOrder	Configuration de l’ordre de tri par défaut sur la table.
keyFieldId	keyFieldId	integer	ID du champ configuré pour être la clé de cette table, qui est généralement l’ID d’enregistrement Quickbase.
singleRecordName	singleRecordName	string	Nom unique configuré par le générateur de la table.
pluralRecordName	pluralRecordName	string	Nom pluriel configuré par le générateur de la table.
sizeLimit	sizeLimit	string	Limite de taille pour la table.
spaceUsed	spaceUsed	string	Quantité d’espace actuellement utilisée par la table.
spaceRemaining	spaceRemaining	string	Quantité d’espace restant à utiliser par la table.

updateTableResponse

Nom	Chemin d’accès	Type	Description
nom	name	string	Nom de la table.
pièce d'identité	id	string	Identificateur unique (dbid) de la table.
alias	alias	string	Alias de table créé automatiquement pour la table.
descriptif	description	string	Description de la table, telle qu’elle est configurée par un administrateur d’application.
créé	created	string	Heure et date de création de la table, au format d’heure ISO 8601 AAAA-MM-DDThh :mm :ssszZ (dans le fuseau horaire UTC).
Actualisé	updated	string	Heure et date de la dernière mise à jour du schéma ou des données de la table, au format d’heure ISO 8601 AAAA-MM-DDThh :mm :sssZ (dans le fuseau horaire UTC).
nextRecordId	nextRecordId	integer	ID d’enregistrement incrémentiel qui sera utilisé lors de la création de l’enregistrement suivant, tel que déterminé lors de l’exécution de l’appel d’API.
nextFieldId	nextFieldId	integer	ID de champ incrémentiel qui sera utilisé lors de la création du champ suivant, comme déterminé lors de l’exécution de l’appel d’API.
defaultSortFieldId	defaultSortFieldId	integer	ID du champ configuré pour le tri par défaut.
DefaultSortOrder	defaultSortOrder	DefaultSortOrder	Configuration de l’ordre de tri par défaut sur la table.
keyFieldId	keyFieldId	integer	ID du champ configuré pour être la clé de cette table, qui est généralement l’ID d’enregistrement Quickbase.
singleRecordName	singleRecordName	string	Nom unique configuré par le générateur de la table.
pluralRecordName	pluralRecordName	string	Nom pluriel configuré par le générateur de la table.
sizeLimit	sizeLimit	string	Limite de taille pour la table.
spaceUsed	spaceUsed	string	Quantité d’espace actuellement utilisée par la table.
spaceRemaining	spaceRemaining	string	Quantité d’espace restant à utiliser par la table.

deleteTableResponse

Nom	Chemin d’accès	Type	Description
deletedTableId	deletedTableId	string	ID de table supprimé.

getRelationshipsResponse

Nom	Chemin d’accès	Type	Description
Relations	relationships	array of Relationship	Relations dans une table.
Métadonnées	metadata	Metadata	Informations supplémentaires sur les résultats qui peuvent être utiles.

Relation

Nom	Chemin d’accès	Type	Description
pièce d'identité	id	integer	ID de relation (ID de champ de clé étrangère).
parentTableId	parentTableId	string	ID de table parent de la relation.
childTableId	childTableId	string	ID de table enfant de la relation.
ForeignKeyField	foreignKeyField	ForeignKeyField	Informations sur le champ clé étrangère.
isCrossApp	isCrossApp	boolean	Indique s’il s’agit d’une relation entre applications.
lookupFields	lookupFields	array of LookupField	Tableau des champs de recherche.
summaryFields	summaryFields	array of SummaryField	Tableau des champs récapitulatives.

ForeignKeyField

Informations sur le champ clé étrangère.

Nom	Chemin d’accès	Type	Description
pièce d'identité	id	integer	ID de champ.
label	label	string	Étiquette de champ.
type	type	string	Type de champ.

LookupField

Nom	Chemin d’accès	Type	Description
pièce d'identité	id	integer	ID de champ.
label	label	string	Étiquette de champ.
type	type	string	Type de champ.

SummaryField

Nom	Chemin d’accès	Type	Description
pièce d'identité	id	integer	ID de champ.
label	label	string	Étiquette de champ.
type	type	string	Type de champ.

Métadonnées

Informations supplémentaires sur les résultats qui peuvent être utiles.

Nom	Chemin d’accès	Type	Description
skip	skip	integer	Nombre de relations à ignorer.
totalRelationships	totalRelationships	integer	Nombre total de relations.
numRelationships	numRelationships	integer	Nombre de relations dans l’objet de réponse actuel.

createRelationshipResponse

Nom	Chemin d’accès	Type	Description
pièce d'identité	id	integer	ID de relation (ID de champ de clé étrangère).
parentTableId	parentTableId	string	ID de table parent de la relation.
childTableId	childTableId	string	ID de table enfant de la relation.
ForeignKeyField	foreignKeyField	ForeignKeyField	Informations sur le champ clé étrangère.
isCrossApp	isCrossApp	boolean	Indique s’il s’agit d’une relation entre applications.
lookupFields	lookupFields	array of LookupField	Tableau des champs de recherche.
summaryFields	summaryFields	array of SummaryField	Tableau des champs récapitulatives.

updateRelationshipResponse

Nom	Chemin d’accès	Type	Description
pièce d'identité	id	integer	ID de relation (ID de champ de clé étrangère).
parentTableId	parentTableId	string	ID de table parent de la relation.
childTableId	childTableId	string	ID de table enfant de la relation.
ForeignKeyField	foreignKeyField	ForeignKeyField	Informations sur le champ clé étrangère.
isCrossApp	isCrossApp	boolean	Indique s’il s’agit d’une relation entre applications.
lookupFields	lookupFields	array of LookupField	Tableau des champs de recherche.
summaryFields	summaryFields	array of SummaryField	Tableau des champs récapitulatives.

deleteRelationshipResponse

Nom	Chemin d’accès	Type	Description
relationshipId	relationshipId	integer	ID de relation.

Query

Définition de requête configurée dans Quickbase qui est exécutée lors de l’exécution du rapport.

Nom	Chemin d’accès	Type	Description
tableId	tableId	string	Identificateur de table pour le rapport.
Filter	filter	string	Filtre utilisé pour interroger les données.
formulaFields	formulaFields	array of FormulaField	Champs de formule calculés.

FormulaField

Nom	Chemin d’accès	Type	Description
pièce d'identité	id	integer	Identificateur de champ de formule.
label	label	string	Étiquette de champ de formule.
FieldType	fieldType	FieldType	Type de valeur de formule résultant.
formule	formula	string	Texte de formule.
decimalPrecision	decimalPrecision	integer	Pour la formule numérique, la précision numérique.

FieldType

Type de valeur de formule résultant.

FieldType: string

getReportResponse

Nom	Chemin d’accès	Type	Description
pièce d'identité	id	string	Identificateur du rapport, unique à la table.
nom	name	string	Nom configuré du rapport.
type	type	string	Type de rapport dans Quickbase (par exemple, graphique).
descriptif	description	string	Description configurée d’un rapport.
ownerId	ownerId	integer	Facultatif, affiché uniquement pour les rapports personnels. ID d’utilisateur du propriétaire du rapport.
Query	query	Query	Définition de requête configurée dans Quickbase qui est exécutée lors de l’exécution du rapport.
Propriétés	properties	object	Liste des propriétés propres au type de rapport. Pour afficher une description détaillée des propriétés de chaque type de rapport, consultez Types de rapports.
usedLast	usedLast	string	Instant où un rapport a été utilisé pour la dernière fois.
usedCount	usedCount	integer	Nombre de fois qu’un rapport a été utilisé.

runReportResponse

Nom	Chemin d’accès	Type	Description
fields	fields	array of Field	Tableau d’objets qui contient des métadonnées limitées de chaque champ affiché dans le rapport. Cela permet de créer une logique qui dépend des types de champs et des ID.
données	data	array of object	Tableau d’objets qui représente les données d’enregistrement ou les valeurs résumées, en fonction du type de rapport.
items	data	object
Metadata1	metadata	Metadata1	Informations supplémentaires sur les résultats qui peuvent être utiles. La pagination peut être nécessaire si vous spécifiez un plus petit nombre de résultats à ignorer que ce qui est disponible, ou si l’API retourne automatiquement moins de résultats. numRecords peut être comparé à totalRecords pour déterminer si une autre pagination est nécessaire.

Terrain

Nom	Chemin d’accès	Type	Description
pièce d'identité	id	integer	ID de champ.
label	label	string	Étiquette de champ.
type	type	string	Type de champ.
labelOverride	labelOverride	string	Remplacement de l’étiquette d’en-tête de colonne pour le champ dans le rapport.

Metadata1

Informations supplémentaires sur les résultats qui peuvent être utiles. La pagination peut être nécessaire si vous spécifiez un plus petit nombre de résultats à ignorer que ce qui est disponible, ou si l’API retourne automatiquement moins de résultats. numRecords peut être comparé à totalRecords pour déterminer si une autre pagination est nécessaire.

Nom	Chemin d’accès	Type	Description
skip	skip	integer	Nombre d’enregistrements à ignorer
numFields	numFields	integer	Nombre de champs dans chaque enregistrement de l’objet réponse actuel
top	top	integer	S’il est présent, le nombre maximal d’enregistrements demandés par l’appelant
totalRecords	totalRecords	integer	Nombre total d’enregistrements dans le jeu de résultats
numRecords	numRecords	integer	Nombre d’enregistrements dans l’objet de réponse actuel

Properties1

Propriétés supplémentaires pour le champ. Pour plus d’informations sur les propriétés de chaque type de champ, consultez la page détails du type de champ.

Nom	Chemin d’accès	Type	Description
comments	comments	string	Commentaires entrés sur les propriétés de champ par un administrateur.
doesTotal	doesTotal	boolean	Indique si ce champ est total dans les rapports au sein du produit.
enregistrement automatique	autoSave	boolean	Indique si le champ de lien est automatiquement enregistré.
defaultValueLuid	defaultValueLuid	integer	Valeur d’ID d’utilisateur par défaut.
maxVersions	maxVersions	integer	Nombre maximal de versions configurées pour une pièce jointe de fichier.
carryChoices	carryChoices	boolean	Indique si le champ doit contenir ses champs de choix multiples lors de la copie.
format	format	integer	Format à afficher l’heure.
longueur maximale	maxLength	integer	Nombre maximal de caractères autorisés pour l’entrée dans Quickbase pour ce champ.
linkText	linkText	string	Valeur de texte configurée qui remplace l’URL que les utilisateurs voient dans le produit.
parentFieldId	parentFieldId	integer	ID du champ composite parent, le cas échéant.
displayTimezone	displayTimezone	boolean	Indique s’il faut afficher le fuseau horaire dans le produit.
summaryTargetFieldId	summaryTargetFieldId	integer	ID du champ utilisé pour agréger les valeurs de l’enfant, le cas échéant. Cela s’affiche 0 si la fonction récapitulative ne nécessite pas de sélection de champ (comme le nombre).
allowNewChoices	allowNewChoices	boolean	Indique si les utilisateurs peuvent ajouter de nouveaux choix à une liste de sélection.
masterChoiceFieldId	masterChoiceFieldId	integer	ID du champ qui est la référence dans la relation.
defaultToday	defaultToday	boolean	Indique si la valeur du champ est définie par défaut aujourd’hui pour les nouveaux enregistrements.
Unités	units	string	Étiquette d’unités.
lookupTargetFieldId	lookupTargetFieldId	integer	ID du champ qui est la cible de la table maître pour cette recherche.
SummaryFunction	summaryFunction	SummaryFunction	Type de fonction d’accumulation récapitulative.
sourceFieldId	sourceFieldId	integer	ID du champ source.
masterTableTag	masterTableTag	string	L’alias de table pour la table maître dans la relation dont ce champ fait partie.
doesAverage	doesAverage	boolean	Indique si ce champ est moyen dans les rapports au sein du produit.
formule	formula	string	Formule du champ tel qu’il est configuré dans Quickbase.
Décimales	decimalPlaces	integer	Nombre de décimales affichées dans le produit pour ce champ.
seeVersions	seeVersions	boolean	Indique si l’utilisateur peut voir d’autres versions, à l’exception de la plus récente, d’une pièce jointe de fichier dans le produit.
displayMonth	displayMonth	string	Comment afficher des mois.
numLines	numLines	integer	Nombre de lignes affichées dans Quickbase pour ce champ de texte.
displayEmail	displayEmail	string	Affichage de l’e-mail.
defaultKind	defaultKind	string	Type par défaut de l’utilisateur.
coverText	coverText	string	Texte convivial de remplacement qui peut être utilisé pour afficher un lien dans le navigateur.
currencySymbol	currencySymbol	string	Symbole actuel utilisé lors de l’affichage des valeurs de champ dans le produit.
masterChoiceTableId	masterChoiceTableId	integer	ID de la table qui est la forme principale de cette relation.
targetFieldId	targetFieldId	integer	ID du champ cible.
displayUser	displayUser	string	Option configurée pour la façon dont les utilisateurs s’affichent dans le produit.
blankIsZero	blankIsZero	boolean	Indique si une valeur vide est traitée comme 0 dans les calculs au sein du produit.
exact	exact	boolean	Indique si une correspondance exacte est requise pour un lien de rapport.
startField	startField	integer	ID du champ de début.
defaultDomain	defaultDomain	string	Domaine de messagerie par défaut.
defaultValue	defaultValue	string	Valeur par défaut configurée pour un champ lorsqu’un nouvel enregistrement est ajouté.
choicesLuid	choicesLuid	array of object	Liste des choix d’utilisateurs.
items	choicesLuid	object
abréger	abbreviate	boolean	N’affichez pas le protocole d’URL lors de l’affichage de l’URL.
xmlTag	xmlTag	string	Balise xml du champ.
targetTableName	targetTableName	string	Nom de la table cible du champ.
formatNombre	numberFormat	integer	Format utilisé pour afficher des valeurs numériques dans le produit (décimal, séparateurs, groupe de chiffres).
appearsAs	appearsAs	string	Le texte du lien, s’il est vide, l’URL sera utilisée comme texte de lien.
width	width	integer	Largeur d’entrée html du champ dans le produit.
CurrencyFormat	currencyFormat	CurrencyFormat	Format monétaire utilisé lors de l’affichage des valeurs de champ dans le produit.
displayImages	displayImages	boolean	Indique si les images s’affichent pour les pièces jointes de fichiers sur les formulaires et les rapports au sein du produit.
foreignKey	foreignKey	boolean	Indique si le champ est une clé étrangère (ou champ de référence) dans une relation.
displayDayOfWeek	displayDayOfWeek	boolean	Indique s’il faut afficher le jour de la semaine dans le produit.
summaryReferenceFieldId	summaryReferenceFieldId	integer	ID du champ qui est la référence dans la relation pour ce résumé.
virguleStart	commaStart	integer	Nombre de chiffres avant l’affichage des virgules dans le produit, le cas échéant.
choices	choices	array of string	Tableau d’entrées qui existent pour un champ qui offre des choix à l’utilisateur.
targetTableId	targetTableId	string	ID de la table cible.
displayRelative	displayRelative	boolean	Indique s’il faut afficher l’heure en tant que relative.
compositeFields	compositeFields	array of object	Tableau des champs qui composent un champ composite (par exemple, adresse).
items	compositeFields	object
VersionMode	versionMode	VersionMode	Modes de version pour les fichiers. Conservez toutes les versions et conservez la dernière version.
displayTime	displayTime	boolean	Indique s’il faut afficher l’heure, en plus de la date.
durationField	durationField	integer	ID du champ de durée.
snapFieldId	snapFieldId	integer	ID du champ utilisé pour les valeurs d’instantané, le cas échéant.
heures24	hours24	boolean	Indique s’il faut afficher l’heure dans le format de 24 heures dans le produit.
sortAlpha	sortAlpha	boolean	Indique s’il faut trier par ordre alphabétique, le tri par défaut est par ID d’enregistrement.
sortAsGiven	sortAsGiven	boolean	Indique si les entrées répertoriées trient comme entrées par ordre alphabétique.
hasExtension	hasExtension	boolean	Indique si ce champ a une extension de téléphone.
Semaine	workWeek	integer	Type de semaine de travail.
useNewWindow	useNewWindow	boolean	Indique si l’URL doit ouvrir une nouvelle fenêtre lorsqu’un utilisateur clique dessus dans le produit.
appendOnly	appendOnly	boolean	Indique si ce champ est ajouté uniquement.
displayAsLink	displayAsLink	boolean	Indique si un champ qui fait partie de la relation doit être affiché en tant que lien hypertexte vers l’enregistrement parent dans le produit.
allowHTML	allowHTML	boolean	Indique si ce champ autorise html.
lookupReferenceFieldId	lookupReferenceFieldId	integer	ID du champ qui est la référence dans la relation pour cette recherche.

SummaryFunction

Type de fonction d’accumulation récapitulative.

SummaryFunction: string

CurrencyFormat

Format monétaire utilisé lors de l’affichage des valeurs de champ dans le produit.

CurrencyFormat: string

VersionMode

Modes de version pour les fichiers. Conservez toutes les versions et conservez la dernière version.

VersionMode: string

Autorisation

Nom	Chemin d’accès	Type	Description
role	role	string	Rôle associé à une autorisation donnée pour le champ
permissionType	permissionType	string	Autorisation donnée au rôle pour ce champ
roleId	roleId	integer	ID du rôle donné

createFieldResponse

Nom	Chemin d’accès	Type	Description
pièce d'identité	id	integer	ID du champ, unique à cette table.
type de champ	fieldType	string	Type de champ, comme décrit ici.
mode	mode	string	Pour les champs dérivés, il s’agit de « recherche », de « résumé » ou de « formule », pour indiquer le type de champ dérivé. Pour les champs non dérivés, il s’agit d’un champ vide.
label	label	string	Étiquette (nom) du champ.
noWrap	noWrap	boolean	Indique si le champ est configuré pour ne pas encapsuler lorsqu’il est affiché dans le produit.
audacieux	bold	boolean	Indique si le champ est configuré pour s’afficher en gras dans le produit.
obligatoire	required	boolean	Indique si le champ est marqué comme obligatoire.
appearsByDefault	appearsByDefault	boolean	Indique si le champ est marqué comme valeur par défaut dans les rapports.
findEnabled	findEnabled	boolean	Indique si le champ est marqué comme pouvant faire l’objet d’une recherche.
unique	unique	boolean	Indique si le champ est marqué comme unique.
doesDataCopy	doesDataCopy	boolean	Indique si les données de champ sont copiées lorsqu’un utilisateur copie l’enregistrement.
fieldHelp	fieldHelp	string	Texte d’aide configuré affiché aux utilisateurs du produit.
Vérifiés	audited	boolean	Indique si le champ est suivi dans le cadre des journaux d’audit De base rapide.
Properties1	properties	Properties1	Propriétés supplémentaires pour le champ. Pour plus d’informations sur les propriétés de chaque type de champ, consultez la page détails du type de champ.
permissions	permissions	array of Permission	Autorisations de champ pour différents rôles.

deleteFieldsResponse

Nom	Chemin d’accès	Type	Description
deletedFieldIds	deletedFieldIds	array of integer	Liste des ID de champ à supprimer.
Erreurs	errors	array of string	Liste des erreurs trouvées.

getFieldResponse

Nom	Chemin d’accès	Type	Description
pièce d'identité	id	integer	ID du champ, unique à cette table.
type de champ	fieldType	string	Type de champ, comme décrit ici.
mode	mode	string	Pour les champs dérivés, il s’agit de « recherche », de « résumé » ou de « formule », pour indiquer le type de champ dérivé. Pour les champs non dérivés, il s’agit d’un champ vide.
label	label	string	Étiquette (nom) du champ.
noWrap	noWrap	boolean	Indique si le champ est configuré pour ne pas encapsuler lorsqu’il est affiché dans le produit.
audacieux	bold	boolean	Indique si le champ est configuré pour s’afficher en gras dans le produit.
obligatoire	required	boolean	Indique si le champ est marqué comme obligatoire.
appearsByDefault	appearsByDefault	boolean	Indique si le champ est marqué comme valeur par défaut dans les rapports.
findEnabled	findEnabled	boolean	Indique si le champ est marqué comme pouvant faire l’objet d’une recherche.
unique	unique	boolean	Indique si le champ est marqué comme unique.
doesDataCopy	doesDataCopy	boolean	Indique si les données de champ sont copiées lorsqu’un utilisateur copie l’enregistrement.
fieldHelp	fieldHelp	string	Texte d’aide configuré affiché aux utilisateurs du produit.
Vérifiés	audited	boolean	Indique si le champ est suivi dans le cadre des journaux d’audit De base rapide.
Properties1	properties	Properties1	Propriétés supplémentaires pour le champ. Pour plus d’informations sur les propriétés de chaque type de champ, consultez la page détails du type de champ.
permissions	permissions	array of Permission	Autorisations de champ pour différents rôles.

updateFieldResponse

Nom	Chemin d’accès	Type	Description
pièce d'identité	id	integer	ID du champ, unique à cette table.
type de champ	fieldType	string	Type de champ, comme décrit ici.
mode	mode	string	Pour les champs dérivés, il s’agit de « recherche », de « résumé » ou de « formule », pour indiquer le type de champ dérivé. Pour les champs non dérivés, il s’agit d’un champ vide.
label	label	string	Étiquette (nom) du champ.
noWrap	noWrap	boolean	Indique si le champ est configuré pour ne pas encapsuler lorsqu’il est affiché dans le produit.
audacieux	bold	boolean	Indique si le champ est configuré pour s’afficher en gras dans le produit.
obligatoire	required	boolean	Indique si le champ est marqué comme obligatoire.
appearsByDefault	appearsByDefault	boolean	Indique si le champ est marqué comme valeur par défaut dans les rapports.
findEnabled	findEnabled	boolean	Indique si le champ est marqué comme pouvant faire l’objet d’une recherche.
unique	unique	boolean	Indique si le champ est marqué comme unique.
doesDataCopy	doesDataCopy	boolean	Indique si les données de champ sont copiées lorsqu’un utilisateur copie l’enregistrement.
fieldHelp	fieldHelp	string	Texte d’aide configuré affiché aux utilisateurs du produit.
Vérifiés	audited	boolean	Indique si le champ est suivi dans le cadre des journaux d’audit De base rapide.
Properties1	properties	Properties1	Propriétés supplémentaires pour le champ. Pour plus d’informations sur les propriétés de chaque type de champ, consultez la page détails du type de champ.
permissions	permissions	array of Permission	Autorisations de champ pour différents rôles.

runFormulaResponse

Nom	Chemin d’accès	Type	Description
résultat	result	string	Résultat de l’exécution de formule.

upsertResponse

Nom	Chemin d’accès	Type	Description
Métadonnées2	metadata	Metadata2	Informations sur les enregistrements créés, les enregistrements mis à jour, les enregistrements référencés mais inchangés et les enregistrements ayant des erreurs lors du traitement.
données	data	array of object	Données attendues pour être retournées.
items	data	object

Métadonnées2

Informations sur les enregistrements créés, les enregistrements mis à jour, les enregistrements référencés mais inchangés et les enregistrements ayant des erreurs lors du traitement.

Nom	Chemin d’accès	Type	Description
createdRecordIds	createdRecordIds	array of integer	Tableau contenant les ID d’enregistrement créés.
lineErrors	lineErrors	object	Cela ne sera retourné que dans le cas d’enregistrements ayant échoué. Il s’agit d’une collection d’erreurs qui se sont produites lors du traitement des données entrantes qui ont entraîné le traitement des enregistrements qui n’ont pas été traités. Chaque objet a une clé représentant le numéro de séquence de l’enregistrement dans la charge utile d’origine (à partir de 1). La valeur est une liste d’erreurs qui se sont produites.
unchangedRecordIds	unchangedRecordIds	array of integer	Tableau contenant les ID d’enregistrement inchangés.
updatedRecordIds	updatedRecordIds	array of integer	Tableau contenant les ID d’enregistrement mis à jour.
totalNumberOfRecordsProcessed	totalNumberOfRecordsProcessed	integer	Nombre d’enregistrements traités. Inclut les mises à jour d’enregistrement réussies et ayant échoué.

deleteRecordsResponse

Nom	Chemin d’accès	Type	Description
numberDeleted	numberDeleted	integer	Nombre d’enregistrements supprimés.

runQueryResponse

Nom	Chemin d’accès	Type	Description
fields	fields	array of Fields2	Tableau d’objets qui contient des métadonnées limitées de chaque champ affiché dans le rapport. Cela permet de créer une logique qui dépend des types de champs et des ID.
données	data	array of object	Tableau d’objets qui représente les données d’enregistrement ou les valeurs résumées, en fonction du type de rapport.
items	data	object
Metadata1	metadata	Metadata1	Informations supplémentaires sur les résultats qui peuvent être utiles. La pagination peut être nécessaire si vous spécifiez un plus petit nombre de résultats à ignorer que ce qui est disponible, ou si l’API retourne automatiquement moins de résultats. numRecords peut être comparé à totalRecords pour déterminer si une autre pagination est nécessaire.

Champs2

Nom	Chemin d’accès	Type	Description
pièce d'identité	id	integer	ID de champ.
label	label	string	Étiquette de champ.
type	type	string	Type de champ.

getTempTokenDBIDResponse

Nom	Chemin d’accès	Type	Description
temporaryAuthorization	temporaryAuthorization	string	Jeton d’autorisation temporaire.

cloneUserTokenResponse

Nom	Chemin d’accès	Type	Description
active	active	boolean	Indique si le jeton utilisateur est actif.
apps	apps	array of App	La liste des applications auxquelles ce jeton d’utilisateur est attribué.
lastUsed	lastUsed	string	La dernière date à laquelle ce jeton utilisateur a été utilisé, au format horaire ISO 8601 AAAA-MM-DDThh :mm :sssZ (dans le fuseau horaire UTC).
descriptif	description	string	Description du jeton utilisateur.
pièce d'identité	id	integer	ID de jeton utilisateur.
nom	name	string	Nom du jeton d’utilisateur.
token	token	string	Valeur du jeton utilisateur.

Application

Nom	Chemin d’accès	Type	Description
pièce d'identité	id	string	Identificateur unique pour cette application.
nom	name	string	Nom de l’application.

deleteUserTokenResponse

Nom	Chemin d’accès	Type	Description
pièce d'identité	id	integer	ID de jeton utilisateur.

deleteFileResponse

Nom	Chemin d’accès	Type	Description
versionNumber	versionNumber	integer	Nombre de versions supprimées.
fileName	fileName	string	Nom du fichier associé à la version supprimée.
Téléchargé	uploaded	string	Horodatage lorsque la version a été chargée à l’origine.
Créateur	creator	Creator	Utilisateur qui a chargé la version.

Créateur

Utilisateur qui a chargé la version.

Nom	Chemin d’accès	Type	Description
nom	name	string	Nom complet de l’utilisateur.
pièce d'identité	id	string	Identifiant.
Messagerie électronique	email	string	E-mail utilisateur.
nom d’utilisateur	userName	string	Nom d’utilisateur mis à jour dans les propriétés utilisateur. Facultatif, s’affiche s’il n’est pas identique à l’e-mail utilisateur.

ficelle

Il s’agit du type de données de base « string ».

Partager via

Quickbase (Éditeur indépendant)

Création d’une connexion

Faire défaut

Limitations

Actions

Cloner un jeton utilisateur

Paramètres

Retours

Copier une application

Paramètres

Retours

Créer un champ

Paramètres

Retours

Créer une application

Paramètres

Retours

Créer une relation

Paramètres

Retours

Créer une table

Paramètres

Retours

Désactiver un jeton utilisateur

Retours

Exécuter un rapport

Paramètres

Retours

Exécuter une formule

Paramètres

Retours

Insérer des enregistrements de mise à jour andor

Paramètres

Retours

Mettre à jour un champ

Paramètres

Retours

Mettre à jour une application

Paramètres

Retours

Mettre à jour une relation

Paramètres

Retours

Mettre à jour une table

Paramètres

Retours

Obtenir des champs pour une table

Paramètres

Retours

Obtenir des tables pour une application

Paramètres

Retours

Obtenir des événements d’application

Paramètres

Retours

Obtenir le champ

Paramètres

Retours

Obtenir l’utilisation de tous les champs

Paramètres

Retours

Obtenir tous les rapports de table

Paramètres

Retours

Obtenir toutes les relations

Paramètres

Retours

Obtenir un jeton temporaire pour un DBID

Paramètres

Retours

Obtenir un rapport

Paramètres

Retours

Obtenir une application

Paramètres

Retours

Obtenir une table

Paramètres

Retours