Endpoint de Ativos de BI
Aceda a dados de ativos num formato aplanado otimizado para ferramentas de Business Intelligence. Todos os campos estão no nível de raiz para um mapeamento direto de colunas.
Endpoints Disponíveis
| Método | Endpoint | Descrição |
|---|---|---|
| GET | /bi/v1/assets | Listar todos os ativos em formato plano |
| GET | /bi/v1/assets/count | Obter a contagem total de ativos |
| GET | /bi/v1/assets/{id} | Obter um ativo específico por ID |
Listar todos os ativos
Devolve uma lista paginada de ativos com todos os campos nivelados para o nível raiz. Ideal para exportação de dados em massa para ferramentas de BI.
Parâmetros de consulta
| status | Filtrar por estado do ativo (ex.: ACTIVE, INACTIVE) |
| policy | Filtrar por nome do caminho da política atribuída |
| page | Número de página (índice 0, predefinição: 0) |
| size | Tamanho de página (predefinição: 20, máx.: 100) |
| sort | Campo e direção de ordenação (ex.: lastSyncAt,desc) |
curl "https://api.nomid.tech/emm/api/bi/v1/assets?page=0&size=100" \
-H "X-API-Key: nm_acme_abc123..." Obter Contagem de Ativos
Devolve a contagem total de ativos que correspondem aos critérios de filtro. Útil para cálculos de paginação.
GET /bi/v1/assets/countObter ativo específico
Devolve um único ativo em formato plano através do respetivo ID de ativo.
GET /bi/v1/assets/{id}Esquema BiAssetDto
Cada objeto de ativo segue a estrutura plana BiAssetDto. Todos os campos são strings ao nível da raiz - sem objetos ou arrays aninhados.
| Campo | Descrição |
|---|---|
| pathName | Caminho completo do ativo (ex.: enterprises/acme/assets/abc123) |
| identification | Identificador intuitivo para o ativo |
| name | Nome do dispositivo |
| description | Descrição do dispositivo |
| serialNumber | Número de série do dispositivo |
| imeis | Números IMEI (separados por vírgulas se múltiplos) |
| brand | Fabricante/marca do dispositivo |
| model | Nome do modelo do dispositivo |
| status | Estado do ativo (ACTIVE, INACTIVE) |
| lastSyncAt | Carimbo de data/hora da última sincronização (ISO 8601) |
| enrollmentTime | Carimbo de data/hora de registo do dispositivo (ISO 8601) |
| policyPathName | Caminho completo da política atribuída |
| policyDisplayName | Nome da política legível por humanos |
| policyGroupName | Grupo de políticas para categorização |
| metadata | Metadados personalizados como string JSON |
| tags | Etiquetas como string separada por vírgulas |
| operatingSystem | Nome do SO (por ex., Android) |
| operatingSystemVersion | Número da versão do SO |
API pública vs. API de BI
A principal diferença reside na estrutura da resposta. A API pública utiliza objetos aninhados para organização, enquanto a API de BI nivela tudo para facilitar o mapeamento de colunas.
Paginação
Os resultados são paginados utilizando o mesmo formato que a API pública. Utilize os parâmetros page e size para navegar por grandes conjuntos de dados.