Consultando os documents de uma entidade pelo nome

GET https://api.fbits.net/document/values/by-entity-name/{name}

Para listar os documents de uma entidade pelo nome, utilize o endpoint Retorna os documents de uma entidade pelo nome.

A listagem é paginada por cursor sobre o id do document, em ordem crescente, e retorna no máximo 50 itens por página.

Parâmetros para consulta:

  • name - nome da entidade (a busca não diferencia maiúsculas de minúsculas);
  • after - cursor de avanço: retorna os documents com id maior que o informado (opcional);
  • before - cursor de retorno: retorna os documents com id menor que o informado (opcional);
  • limit - quantidade de itens da página, de 1 a 50. Quando não informado, assume 50.
🚧

after e before são mutuamente exclusivos. Informar os dois na mesma chamada retorna 400.

Exemplo de chamada:

GET https://api.fbits.net/document/values/by-entity-name/ficha-tecnica?limit=2
GET https://api.fbits.net/document/values/by-entity-name/ficha-tecnica?after=4502&limit=2

Response body:

{
  "items": [
    {
      "id": 4501,
      "documentEntityId": 12,
      "value": "{\"sku\":\"ABC-123\",\"peso\":1.75}",
      "createdAt": "2026-07-27T16:20:00.000Z",
      "updatedAt": "2026-07-27T16:20:00.000Z"
    },
    {
      "id": 4502,
      "documentEntityId": 12,
      "value": "{\"sku\":\"DEF-456\",\"peso\":0.9}",
      "createdAt": "2026-07-27T16:31:12.000Z",
      "updatedAt": "2026-07-27T16:31:12.000Z"
    }
  ],
  "pageInfo": {
    "hasNextPage": true,
    "hasPreviousPage": false,
    "startCursor": 4501,
    "endCursor": 4502
  }
}

Campos de pageInfo

CampoTipoDescrição
hasNextPagebooleanoIndica se existem documents após a página atual
hasPreviousPagebooleanoIndica se existem documents antes da página atual
startCursorinteiroid do primeiro document da página. Nulo quando a página é vazia
endCursorinteiroid do último document da página. Nulo quando a página é vazia

Para percorrer todos os documents, repita a chamada enviando after com o endCursor da página anterior enquanto hasNextPage for true. Para navegar no sentido inverso, envie before com o startCursor.

🚧

Quando não existe entidade com o nome informado, o retorno é 404.