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. É também a única rota de listagem que aceita filtros.

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;
externalId - identificador de origem a filtrar. Parâmetro repetível, com no máximo 50 valores (opcional);
createdFrom - limite inferior da data de cadastro, em UTC (opcional);
createdTo - limite superior da data de cadastro, em UTC (opcional).

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

Filtros da listagem

Os três filtros são opcionais e combinados entre si — e com a paginação — por E (AND): o document precisa satisfazer todos os filtros informados para aparecer na página. Quando nenhum filtro é enviado, a listagem se comporta exatamente como antes da introdução deles.

Filtro	Descrição
`externalId`	Seleciona os documents cujo `externalId` esteja entre os valores informados. Repetível (`?externalId=A&externalId=B`), com no máximo 50 valores por chamada
`createdFrom`	Seleciona os documents com data de cadastro maior ou igual ao instante informado
`createdTo`	Seleciona os documents com data de cadastro menor ou igual ao instante informado

`externalId`

É um parâmetro repetível: cada valor vai em uma ocorrência própria do parâmetro. Vírgulas não separam valores — ?externalId=A,B procura um único identificador chamado A,B;
Valores vazios ou compostos apenas de espaços em branco são descartados;
Documents com externalId nulo nunca são retornados quando o filtro é informado;
Um valor sem correspondência não é erro: ele simplesmente não traz resultado;
Mais de 50 valores na mesma chamada retornam 400.

`createdFrom` e `createdTo`

As datas são interpretadas em UTC, coerentes com o createdAt gravado nos documents. São aceitos:

Formato	Exemplo	Interpretação
Data pura	`2026-08-31`	Ver a regra do dia inteiro abaixo
Data com horário, sem fuso	`2026-08-31T10:30:00`	Assumida como UTC
Data com horário e sufixo Z	`2026-08-31T10:30:00Z`	UTC
Data com offset explícito	`2026-08-31T10:30:00-03:00`	Convertida para UTC (`13:30:00` em UTC)

🚧
Data pura x data com horário

createdFrom como data pura considera o início daquele dia;

createdTo como data pura cobre o dia inteiro — um document cadastrado em 2026-08-31T09:00:00Z entra no resultado de createdTo=2026-08-31;

createdTo com horário vale pelo instante exato informado — o mesmo document não entra no resultado de createdTo=2026-08-31T00:00:00.

Um valor de data que não corresponda a nenhum dos formatos aceitos retorna 400.

🚧
Reenvie os filtros a cada página
Os cursores carregam apenas a posição, não o critério. Pedir a página seguinte informando somente o after devolve uma consulta sem filtros, sem erro algum. Ao paginar um resultado filtrado, reenvie externalId, createdFrom e createdTo em todas as chamadas.

Os filtros não alteram a ordenação (id crescente), o tamanho máximo da página (50) nem a semântica de pageInfo.

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
GET https://api.fbits.net/document/values/by-entity-name/ficha-tecnica?externalId=ERP-0001&externalId=ERP-0003
GET https://api.fbits.net/document/values/by-entity-name/ficha-tecnica?createdFrom=2026-08-01&createdTo=2026-08-31
GET https://api.fbits.net/document/values/by-entity-name/ficha-tecnica?createdFrom=2026-08-01&limit=2&after=4502

Response body:

{
  "items": [
    {
      "id": 4501,
      "documentEntityId": 12,
      "externalId": "ERP-0001",
      "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,
      "externalId": null,
      "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`

Campo	Tipo	Descrição
`hasNextPage`	booleano	Indica se existem documents após a página atual
`hasPreviousPage`	booleano	Indica se existem documents antes da página atual
`startCursor`	inteiro	`id` do primeiro document da página. Nulo quando a página é vazia
`endCursor`	inteiro	`id` 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. O retorno é 400 quando after e before são informados juntos, quando uma das datas está em formato não aceito ou quando são informados mais de 50 valores em externalId.

Updated 12 days ago

Consultando os documents de uma entidade pelo nome

Parâmetros para consulta:

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

Filtros da listagem

`externalId`

`createdFrom` e `createdTo`

Data pura x data com horário

Reenvie os filtros a cada página

Exemplo de chamada:

Response body:

Campos de `pageInfo`

Quando não existe entidade com o nome informado, o retorno é `404`. O retorno é `400` quando `after` e `before` são informados juntos, quando uma das datas está em formato não aceito ou quando são informados mais de 50 valores em `externalId`.

Parâmetros para consulta:

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

Filtros da listagem

externalId

createdFrom e createdTo

Data pura x data com horário

Reenvie os filtros a cada página

Exemplo de chamada:

Response body:

Campos de pageInfo

Quando não existe entidade com o nome informado, o retorno é 404. O retorno é 400 quando after e before são informados juntos, quando uma das datas está em formato não aceito ou quando são informados mais de 50 valores em externalId.

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

`externalId`

`createdFrom` e `createdTo`

Campos de `pageInfo`

Quando não existe entidade com o nome informado, o retorno é `404`. O retorno é `400` quando `after` e `before` são informados juntos, quando uma das datas está em formato não aceito ou quando são informados mais de 50 valores em `externalId`.