Search docs/

Buscar Publicações

{...}

Busca de publicações. Podem ser aplicados filtros bem como busca de texto livre através do parametro q na query

GET https://api.layers.digital/v1/post/search
CopiarCopiado

Autenticação

Autenticação do tipo Token Bearer é necessária para acessar essa rota. O app deve estar cadastrado para usar a API com a permissão user:read

Parâmetros

  • community-id
    (header)
    obrigatório
    Identificador da comunidade
  • createdAt
    (query)
    Data de criação do documento
  • updateAt
    (query)
    Data da última modificação do documento
  • viewAt
    (query)
    Data na qual a publicação ficou visível para o público alvo
  • date
    (query)
    Data da publicação. (Apenas para publicações da agenda e eventos)
  • userId
    (query)
    Identificador do documento
  • active
    (query)
    Indicador do estado do documento. Quando verdadeiro o documento está ativo e quando falso o documento está apagado.
  • approved
    (query)
    Indica se o post já foi aprovado para ser publicado ou ainda aguarda autorização
  • roles
    (query)
    Permissão que o usuário possui
  • season
    (query)
    Temporada do documento. Geralmente é o ano letivo.
  • tags
    (query)
    Array contendo os identificadores de todo público alvo que pode ver essa publicação (grupos, usuários, alunos e turmas)
  • updateAt
    (query)
    Data da última modificação do documento
  • updateAt
    (query)
    Data da última modificação do documento
  • author.name
    (query)
    Nome do autor da publicação
  • author.id
    (query)
    Id do autor da publicação
  • q
    (query)
    Texto de busca. Pode ser o título da publicação ou nome de algum dos targets

Resposta

Especificação

  • totalNumber

    Número total de posts que se encaixam nos filtros aplicados na query

  • hitsBasePost[ ]

    Publicações encontradas ordenadas por quão bem se encaixam na busca

Exemplo

{
  "total": 1,
  "hits": [
    {
      "id": "5bb2575199d7179dfe85be02",
      "createdAt": "2020-09-15T14:14:14.277Z",
      "updatedAt": "2020-09-15T14:14:14.277Z",
      "type": "exemplo",
      "title": "exemplo",
      "text": "exemplo",
      "targets": [
        {
          "id": "exemplo",
          "kind": "exemplo"
        },
        {
          "email": "exemplo",
          "kind": "exemplo"
        },
        {
          "alias": "exemplo",
          "kind": "exemplo"
        }
      ],
      "roles": [
        "guardian"
      ],
      "viewAt": "exemplo",
      "date": "2020-09-15T14:14:14.277Z",
      "event": {
        "endDate": "2020-09-15T14:14:14.277Z",
        "allDay": true
      }
    }
  ]
}
CopiarCopiado