JSON API - Status
| Method: GET |
| Endpoint: /status/<name> |
| Parameters: None |
Description
Returns detailed status on a single agent.
Parameters
A url-encoded string should be included after /status/ in the URL. If an agent with that name exists, you'll be given extended details about it.
A special note - if your asset name contains the '#' character, be aware that this will often not be encoded correctly. Replace any '#' characters with the code '%23'.
Response
Returns a JSON-encoded payload.
- sample.json
{ "name": "Detection Type @ Detection Asset", "inputs": [-0.952, -0.916, -0.868], "basedon": "Detection Type", "ardiid": 124,"ardiname": "Detection Asset", "values": [12.0,21.0,33.0] }
The response is an array of JSON objects that include following fields…
| Field Name | Meaning |
|---|---|
| Name | The full name of the agent, made up of the agent name and the asset the agent is connected to. |
| Inputs | The normalised inputs used for the agent. |
| Values | The original (un-normalised) inputs used for the agent. |
| BasedOn | The name of the agent |
| ARDIName | The name asset the agent is attached to |
| ARDIID | The internal ARDI ID number for the asset |