API de Ativos

Endpoints para aceder a informações de ativos na sua organização. Os ativos representam itens de inventário que podem ou não estar registados como dispositivos geridos.

Endpoints Disponíveis

MétodoEndpointDescrição
GET/assetsListar todos os ativos com paginação e filtragem
GET/assets/countObter a contagem total de ativos
GET/assets/{id}Obter detalhes de um ativo específico

Listar Ativos

Devolve uma lista paginada de ativos com filtragem opcional. Por predefinição, os resultados são ordenados por syncedAt de forma descendente.

Parâmetros de consulta

CampoDescrição
statusFiltrar por estado do ativo (ex.: ACTIVE, INACTIVE)
policyFiltrar por nome do caminho da política atribuída
pageNúmero de página (índice 0, predefinição: 0)
sizeTamanho de página (predefinição: 20, máx.: 100)
sortCampo e direção de ordenação (ex.: syncedAt,desc)
curl "https://api.nomid.tech/emm/api/v1/assets?page=0&size=20" \
  -H "X-API-Key: nm_acme_abc123..."

Obter Contagem de Ativos

Devolve a contagem total de ativos correspondentes aos critérios do filtro. Suporta os mesmos parâmetros de filtro que o endpoint de listagem.

GET /assets/count

Obter Ativo

Devolve informações detalhadas sobre um ativo específico através do respetivo ID, incluindo todos os objetos aninhados.

GET /assets/{id}

Esquema da Resposta

Cada objeto de ativo segue a estrutura PublicAssetDto com objetos aninhados para dados personalizados, especificações de hardware e informações de dispositivos geridos.

Campos de Nível Superior

pathNameCaminho completo do ativo na hierarquia (ex.: enterprises/acme/assets/asset_abc123)
identificationIdentificador intuitivo ou nome de apresentação do ativo
statusEstado atual do ativo (ACTIVE, INACTIVE, etc.)
syncedAtCarimbo de data/hora ISO 8601 da última sincronização
customDataObjeto que contém metadados personalizados e etiquetas
specificationsObjeto que contém especificações de hardware
managedDeviceObjeto que contém informações do dispositivo EMM, ou null se não estiver registado

Objeto customData

Pares chave-valor de metadados personalizados (ex.: department, location)

Array de etiquetas de texto para categorização

Objeto specifications

Número de série do dispositivo

Nome do modelo do dispositivo

Objeto managedDevice

Este objeto é null quando o ativo não se encontra registado como dispositivo gerido no sistema EMM.

Paginação

Os endpoints de listagem devolvem resultados paginados utilizando o formato Page do Spring:

Escolha o seu horário

A carregar...
Abrir calendário de reservas