Explorer Learn

Queues a learn operation to read the point list from a discovered source. Learns run asynchronously - this endpoint returns an op_id once the operation is queued, and the results are read from Explorer Points after it completes. See Explorer for the full sequence.

POST /v1/explorer/learn

curl https://api.novant.io/v1/explorer/learn \
  -X POST \
  -u ak_sample_123: \
  -d source_id=c1578fe370e4 \
  --compressed

Parameters

source_id Required

Discovery id of the source to learn, as returned by Explorer Sources.

node_id

Serial number of the edge node to run this operation on. If not specified, the node that discovered the source is used.

Everything else is derived from the source itself — its protocol, address, device id, and any credential used to discover it. There is no separate learn operation per protocol; the source determines how it is read.

Returns

Returns the id of the queued operation. Poll Explorer Ops to track it.

{
  "status": "ok",
  "op_id": "0a1b2c3d4e5f6a7b"
}

Once the operation completes, the source’s point_count and last_learn fields are populated in Explorer Sources, and its points are available from Explorer Points.

A learn reads the full point list for the source. Learning a source that has already been learned replaces its previous results.

Errors