Rechercher dans les tableaux de bord

Version 4.0.23.6 (la plus récente)

Rechercher dans les tableaux de bord

Si plusieurs paramètres de recherche sont fournis et que filter_or est défini sur FALSE ou non spécifié, les paramètres de recherche sont combinés dans une opération logique AND. Seules les lignes correspondant à tous les critères de recherche sont renvoyées.

Si filter_or est VRAI, plusieurs paramètres de recherche sont combinés dans une opération logique OU. Les résultats comprennent les lignes qui correspondent à n'importe lequel des critères de recherche.

Les paramètres de recherche de chaîne utilisent une correspondance non sensible à la casse. Les paramètres de recherche de chaîne peuvent contenir % et '_' en tant qu'expressions génériques de correspondance de type SQL like. example="dan%" correspond à "danger" et "Danzig", mais pas "David", example="D_m%" correspond à "Damage" et "dump"

Les paramètres de recherche de nombres entiers peuvent accepter une valeur unique ou une liste de valeurs séparées par une virgule. Les différentes valeurs seront combinées sous la forme d'une opération logique OU. Les résultats correspondront à au moins une des valeurs données.

La plupart des paramètres de recherche peuvent accepter "IS NULL" et "NOT NULL" en tant qu'expressions spéciales pour faire correspondre ou exclure (respectivement) les lignes dont la colonne est nulle.

Les paramètres de recherche booléens n'acceptent que les valeurs "true" et "false".

Demande

GET /boards/search
Type de données
Description
Demande
HTTPRequest
query
Requête HTTP
Développer la définition de la requête HTTP...
title
string
Correspond au titre du tableau.
créé le
string
Correspond à l'horodatage de la création du tableau.
first_name
string
Prénom de l'utilisateur qui a créé ce tableau.
last_name
string
Nom de l'utilisateur qui a créé ce tableau.
champs
string
Champs demandés.
ajouté aux favoris
booléen
Afficher les tableaux préférés lorsque la valeur est "true".
id_créateur
string
Filtrer les tableaux créés par un utilisateur en particulier.
tri
string
Champs selon lesquels les résultats doivent être triés
page
integer
Page à afficher. OBSOLÈTE. Utilisez plutôt le décalage.
par_page
integer
Nombre d'articles sur la page renvoyée. OBSOLÈTE. Utilisez plutôt la limite.
offset
integer
Nombre d'éléments à ignorer avant de renvoyer un élément. (utilisé avec une limite et prévaut sur la page et par_page)
limite
integer
Le nombre maximum d'éléments à renvoyer. (utilisé avec un décalage et qui est prioritaire sur la page et par_page)
filtre_ou
booléen
Combiner les critères de recherche indiqués dans une expression booléenne OU
autorisation
string
Filtrer les résultats en fonction de l'autorisation : afficher (par défaut) ou mettre à jour

Réponse

200: plateaux

Type de données
Description
(tableau)
peut
objet
Opérations que l'utilisateur actuel peut effectuer sur cet objet
id_métadonnées_contenu
string
ID de l'enregistrement content_metadata associé
créé le
string
Date de création du tableau
supprimé_à
string
Date de suppression du tableau
description
string
Description du tableau
sections_du_tableau
Développer la définition de BoardSection...
peut
objet
Opérations que l'utilisateur actuel peut effectuer sur cet objet
créé le
string
Heure à laquelle cette section a été créée.
supprimé_à
string
Heure à laquelle cette section a été supprimée.
description
string
Description du contenu de cette section.
id_board
string
Référence d'ID à la carte parente
éléments_du_tableau
Développer la définition de BoardItem...
peut
objet
Opérations que l'utilisateur actuel peut effectuer sur cet objet
contenu_créé_par
string
Nom de l'utilisateur qui a créé le contenu sur lequel repose cet élément
id_favori_contenu
string
Identifiant de contenu préféré associé à l'élément sur lequel ce contenu est basé
id_métadonnées_contenu
string
ID des métadonnées de contenu associé à l'élément sur lequel ce contenu est basé
contenu mis à jour à
string
Dernière fois que le contenu sur lequel se base cet élément a été mis à jour
description_personnalisée
string
Description personnalisée saisie par l'utilisateur, le cas échéant
titre_personnalisé
string
Titre personnalisé saisi par l'utilisateur, le cas échéant
URL personnalisée
string
URL personnalisée saisie par l'utilisateur (le cas échéant)
id_tableau_de_bord
string
Tableau de bord sur lequel baser cet élément
description
string
Description réelle à afficher
nombre_favori
integer
Nombre de fois où le contenu a été ajouté aux favoris (le cas échéant)
id_section_board
string
Section du Conseil associé
id
string
Identifiant unique
image_url
string
URL_image réelle à afficher
location
string
Nom du dossier de conteneur du contenu
id_look
string
Essayez de baser cet élément sur
id_tableaudetableau_de_lookml
string
Tableau de bord LookML sur lequel baser cet élément
order
integer
Entier arbitraire représentant l'ordre de tri dans la section
title
string
Titre à afficher
url
string
URL relative du contenu associé
utiliser_description_personnalisée
booléen
Indique si la description personnalisée doit être utilisée à la place de la description du contenu, si l'élément est associé au contenu
utiliser un titre personnalisé
booléen
Indique si le titre personnalisé doit être utilisé à la place du titre du contenu, si l'élément est associé au contenu
utiliser_url_personnalisée
booléen
Indique si l'URL personnalisée doit être utilisée à la place de l'URL de contenu si l'élément est associé à du contenu.
nombre_vues
integer
Nombre de vues du contenu, le cas échéant
base_données_image_personnalisée64
string
Données d'image encodées en base64 (écriture seule)
URL_image_personnalisée
string
L'élément image_url personnalisé saisi par l'utilisateur (le cas échéant)
utiliser_image_personnalisée
booléen
Indique si l'image personnalisée doit être utilisée à la place de l'image du contenu, si l'élément est associé au contenu
id
string
Identifiant unique
item_order [commande_article]
chaîne[]
ordre_élément_visible
chaîne[]
title
string
Nom de la ligne
mis à jour le
string
Heure à laquelle cette section a été mise à jour pour la dernière fois.
id
string
Identifiant unique
ordre_section
chaîne[]
title
string
Intitulé du conseil
mis à jour le
string
Date de la dernière mise à jour du tableau
user_id
string
ID utilisateur du créateur du conseil d'administration
page_principale
booléen
Indique si le tableau est la page d'accueil principale ou non.

400 Bad Request

Type de données
Description
(objet)
Message
string
Infos sur l'erreur
documentation_url
string
Lien vers la documentation

404: introuvable

Type de données
Description
(objet)
Message
string
Infos sur l'erreur
documentation_url
string
Lien vers la documentation

Examples