Pesquisar painéis

Versão 4.0.23.6 (mais recente)

Pesquisar painéis

Se vários parâmetros de pesquisa forem fornecidos e filter_or for FALSE ou não for especificado, eles serão combinados em uma operação lógica AND. Somente as linhas que correspondem a todos os critérios de parâmetro de pesquisa serão retornadas.

Se filter_or for TRUE, vários parâmetros de pesquisa serão combinados em uma operação lógica OR. Os resultados incluirão linhas que correspondem a qualquer um dos critérios de pesquisa.

Os parâmetros de pesquisa da string usam correspondência indiferente a maiúsculas. Os parâmetros de pesquisa de string podem conter % e '_' como SQL COMO o padrão de correspondência de expressões de caractere curinga. example="dan%" corresponderá a "danger" e "Danzig", mas não a "David" example="D_m%" corresponderá a "Dageage" e "dump"

Parâmetros de pesquisa de número inteiro podem aceitar um único valor ou uma lista de valores separados por vírgulas. Os vários valores serão combinados em uma operação lógica de OR. Os resultados corresponderão a pelo menos um dos valores fornecidos.

A maioria dos parâmetros de pesquisa pode aceitar "IS NULL" e "NOT NULL" como expressões especiais para corresponder ou excluir (respectivamente) linhas em que a coluna é nula.

Os parâmetros de pesquisa booleana só aceitam valores "verdadeiro" e "falso".

Solicitação

GET /boards/search
Tipo de dados
Descrição
Solicitação
HTTPRequest
consulta
Consulta HTTP
Expandir a definição de HTTPQuery...
title
string
Corresponde ao título do quadro.
criado_em
string
Corresponde ao carimbo de data/hora da criação do tabuleiro.
first_name
string
O nome do usuário que criou o quadro.
last_name
string
O sobrenome do usuário que criou este tabuleiro.
campos
string
Campos solicitados.
adicionou como favorito
booleano
Retorna boards favoritos quando verdadeiro.
ID do criador
string
Filtrar em painéis criados por um usuário específico.
classificações
string
Os campos para classificar os resultados
page
integer
A página a ser retornada. OBSOLETO. Em vez disso, use offset.
por_página
integer
Número de itens na página retornada. OBSOLETO. Use limite.
offset
integer
O número de itens a serem ignorados antes de retornar qualquer um. (usado com limite e tem prioridade sobre página e por página)
limite
integer
O número máximo de itens para retornar. (usado com deslocamento e tem prioridade sobre página e por página)
filtro_ou
booleano
Combinar determinados critérios de pesquisa em uma expressão booleana OR
permissão
string
Filtrar resultados com base na permissão, mostrar (padrão) ou atualizar

Resposta

200: tabuleiros

Tipo de dados
Descrição
(matriz)
pode
objeto
Operações que o usuário atual pode realizar neste objeto
Content_metadata_id
string
ID do registro content_metadata associado
criado_em
string
Data de criação do conselho
excluído_em
string
Data de exclusão do Jamboard
Descrição
string
Descrição do tabuleiro
seções de tabuleiro
Expandir definição do BoardSection...
pode
objeto
Operações que o usuário atual pode realizar neste objeto
criado_em
string
Hora em que a seção foi criada.
excluído_em
string
Hora em que esta seção foi excluída.
Descrição
string
Descrição do conteúdo encontrado nesta seção.
ID do board
string
Referência de ID para a placa-mãe
board_items
Expandir a definição de BoardItem...
pode
objeto
Operações que o usuário atual pode realizar neste objeto
content_created_by
string
Nome do usuário que criou o conteúdo no qual este item se baseia
content_favorite_id [código_de_conteúdo]
string
ID do conteúdo favorito associado ao item em que o conteúdo se baseia
Content_metadata_id
string
ID dos metadados de conteúdo associado ao item no qual este conteúdo se baseia
content_updated_at
string
A última atualização do conteúdo deste item foi atualizada.
descrição_personalizada
string
Descrição personalizada inserida pelo usuário, se houver
título_personalizado
string
Título personalizado inserido pelo usuário, se presente
URL_personalizado
string
URL personalizado inserido pelo usuário, se presente
ID do painel
string
Painel para basear este item
Descrição
string
A descrição real da Rede de Display
contagem_favorita
integer
Número de vezes que o conteúdo foi adicionado aos favoritos, se presente
Board_section_id
string
Seção da diretoria associada
id
string
ID exclusivo
image_url
string
O image_url real para exibição
local
string
O nome da pasta do conteúdo
look_id
string
Procure basear este item em
lookml_dashboard_id
string
LookML Dashboard para basear este item
order
integer
Um número inteiro arbitrário que representa a ordem de classificação na seção
title
string
O título real da Rede de Display
url
string
URL relativo do conteúdo associado
usar_descrição_personalizada
booleano
Se a descrição personalizada deve ser usada em vez da descrição do conteúdo, se o item estiver associado ao conteúdo
usar_título_personalizado
booleano
Se o título personalizado deve ser usado em vez do título do conteúdo, se o item estiver associado ao conteúdo
usar_URL_personalizado
booleano
Se o URL personalizado deve ser usado no lugar do URL de conteúdo, se o item estiver associado ao conteúdo
contagem_de_visualizações
integer
Número de vezes que o conteúdo foi visualizado, se houver
imagem_personalizada_base_66
string
(Somente gravação) Dados de imagem codificados em base64
URL_da_imagem_personalizado
string
image_url personalizado inserido pelo usuário, se presente
usar_imagem_personalizada
booleano
Se a imagem personalizada deve ser usada no lugar da imagem de conteúdo, se o item estiver associado ao conteúdo
id
string
ID exclusivo
pedido_do_item
string[]
pedidos_visíveis_do_item
string[]
title
string
Nome da linha
atualizado em
string
Hora em que esta seção foi atualizada pela última vez.
id
string
ID exclusivo
pedido_de_seção
string[]
title
string
Título do conselho
atualizado em
string
Data da última atualização do Jamboard
user_id
string
ID do usuário do criador do Jamboard
página inicial_principal
booleano
Se o board é a página inicial principal ou não

400: Solicitação inválida

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
url_da_documentação
string
Link da documentação

404: não encontrado

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
url_da_documentação
string
Link da documentação

Examples